24 lines
1.1 KiB
TypeScript
24 lines
1.1 KiB
TypeScript
import { RemoteProviderInit as _RemoteProviderInit } from "@smithy/credential-provider-imds";
|
|
import { AwsCredentialIdentityProvider } from "@smithy/types";
|
|
export interface RemoteProviderInit extends _RemoteProviderInit {
|
|
}
|
|
/**
|
|
* Create a credential provider function that reads from ECS container metadata service.
|
|
*
|
|
* ```javascript
|
|
* import { fromContainerMetadata } from "@aws-sdk/credential-providers"; // ES6 import
|
|
* // const { fromContainerMetadata } = require("@aws-sdk/credential-providers"); // CommonJS import
|
|
*
|
|
* const foo = new FooClient({
|
|
* credentials: fromInstanceMetadata({
|
|
* // Optional. The connection timeout (in milliseconds) to apply to any remote requests. If not specified, a default value
|
|
* // of`1000` (one second) is used.
|
|
* timeout: 1000,
|
|
* // Optional. The maximum number of times any HTTP connections should be retried. If not specified, a default value of `0`
|
|
* // will be used.
|
|
* maxRetries: 0,
|
|
* }),
|
|
* });
|
|
* ```
|
|
*/
|
|
export declare const fromContainerMetadata: (init?: RemoteProviderInit) => AwsCredentialIdentityProvider;
|