- GetAWSCredentials
- .getAWSCredentials([profileOverride], [pathOverride], [useEnvironmentVariables]) ⇒
Promise.<AWS.Credentials> - .getAWSProfiles([pathOverride]) ⇒
Promise.<Array.<String>>
- .getAWSCredentials([profileOverride], [pathOverride], [useEnvironmentVariables]) ⇒
GetAWSCredentials.getAWSCredentials([profileOverride], [pathOverride], [useEnvironmentVariables]) ⇒ Promise.<AWS.Credentials>
Get an AWS.Credentials instance by reading a local credentials configuration
Kind: static method of GetAWSCredentials
Returns: Promise.<AWS.Credentials> - A promise that resolves with the AWS
Credentials instance
| Param | Type | Default | Description |
|---|---|---|---|
| [profileOverride] | String |
Optional override for the profile to use (defaults to an environment variable AWS_PROFILE first, then AWS_DEFAULT_PROFILE second, and then to "default" lastly) |
|
| [pathOverride] | String |
Optional override for the credentials path (defaults first to the environment variable AWS_CREDENTIALS_PATH, and then to ~/.aws/credentials lastly) |
|
| [useEnvironmentVariables] | Boolean |
false |
Optionally allow environment variables to provide the Credentials instance. This disregards the profile and assumes that the token in the environment variables is desired. Does not read the credentials file if the envirnment variables "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" are present. Defaults to false. |
Get an array of available AWS profiles
Kind: static method of GetAWSCredentials
| Param | Type | Description |
|---|---|---|
| [pathOverride] | String |
Optional AWS credentials file path override |