@aws-js-sdk-v3-prerelease/credential-provider-ini v0.1.0-preview.2
AWS Credential Provider for Node.JS - Shared Configuration Files
This module provides a function, fromSharedConfigFiles
that will create
CredentialProvider
functions that read from a shared credentials file at
~/.aws/credentials
and a shared configuration file at ~/.aws/config
. Both
files are expected to be INI formatted with section names corresponding to
profiles. Sections in the credentials file are treated as profile names, whereas
profile sections in the config file must have the format of[profile
profile-name]
, except for the default profile. Please see the sample
files below for examples of well-formed configuration and
credentials files.
Profiles that appear in both files will not be merged, and the version that appears in the credentials file will be given precedence over the profile found in the config file.
Supported configuration
You may customize how credentials are resolved by providing an options hash to
the fromSharedConfigFiles
factory function. The following options are
supported:
profile
- The configuration profile to use. If not specified, the provider will use the value in theAWS_PROFILE
environment variable or a default ofdefault
.filepath
- The path to the shared credentials file. If not specified, the provider will use the value in theAWS_SHARED_CREDENTIALS_FILE
environment variable or a default of~/.aws/credentials
.configFilepath
- The path to the shared config file. If not specified, the provider will use the value in theAWS_CONFIG_FILE
environment variable or a default of~/.aws/config
.mfaCodeProvider
- A function that returns a a promise fulfilled with an MFA token code for the provided MFA Serial code. If a profile requires an MFA code andmfaCodeProvider
is not a valid function, the credential provider promise will be rejected.roleAssumer
- A function that assumes a role and returns a promise fulfilled with credentials for the assumed role.
Sample files
~/.aws/credentials
[default]
aws_access_key_id=foo
aws_secret_access_key=bar
[dev]
aws_access_key_id=foo2
aws_secret_access_key=bar2
[prod]
aws_access_key_id=foo3
aws_secret_access_key=bar3
~/.aws/config
[default]
aws_access_key_id=foo
aws_secret_access_key=bar
[profile dev]
aws_access_key_id=foo2
aws_secret_access_key=bar2
[profile prod]
aws_access_key_id=foo3
aws_secret_access_key=bar3
[profile "testing host"]
aws_access_key_id=foo4
aws_secret_access_key=bar4
5 years ago
5 years ago
5 years ago
5 years ago