Package Exports
- @aws-sdk/credential-provider-imds
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-sdk/credential-provider-imds) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@aws-sdk/credential-provider-imds
AWS Credential Provider for Node.JS - Instance and Container Metadata
This module provides two CredentialProvider factory functions,
fromContainerMetadata and fromInstanceMetadata, that will create
CredentialProvider functions that read from the ECS container metadata service
and the EC2 instance metadata service, respectively.
A CredentialProvider function created with fromContainerMetadata will return
a promise that will resolve with credentials for the IAM role associated with
containers in an Amazon ECS task. Please see IAM Roles for Tasks
for more information on using IAM roles with Amazon ECS.
A CredentialProvider function created with fromInstanceMetadata will return
a promise that will resolve with credentials for the IAM role associated with
an EC2 instance.
Please see IAM Roles for Amazon EC2
for more information on using IAM roles with Amazon EC2.
Both IMDSv1 (a request/response method) and IMDSv2 (a session-oriented method) are supported.
Please see Configure the instance metadata service for more information.
Supported configuration
You may customize how credentials are resolved by providing an options hash to
the fromContainerMetadata and fromInstanceMetadata factory functions. The
following options are supported:
timeout- The connection timeout (in milliseconds) to apply to any remote requests. If not specified, a default value of1000(one second) is used.maxRetries- The maximum number of times any HTTP connections should be retried. If not specified, a default value of0will be used.