@aws-sdk/credential-provider-process
Advanced tools
@aws-sdk/credential-provider-process - npm Package Compare versions
Comparing version 3.25.0 to 3.27.0
@@ -6,2 +6,13 @@ # Change Log | ||
| # [3.27.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.26.0...v3.27.0) (2021-08-19) | ||
| ### Features | ||
| * **credential-providers:** collect credential providers in single package ([#2672](https://github.com/aws/aws-sdk-js-v3/issues/2672)) ([5375c91](https://github.com/aws/aws-sdk-js-v3/commit/5375c91f8a4d2cac6918885843718f47ce82e5d5)) | ||
| # [3.25.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.24.0...v3.25.0) (2021-08-05) | ||
@@ -8,0 +19,0 @@ |
| { | ||
| "name": "@aws-sdk/credential-provider-process", | ||
| "version": "3.25.0", | ||
| "version": "3.27.0", | ||
| "description": "AWS credential provider that sources credential_process from ~/.aws/credentials and ~/.aws/config", | ||
@@ -24,3 +24,3 @@ "main": "./dist/cjs/index.js", | ||
| "dependencies": { | ||
| "@aws-sdk/property-provider": "3.25.0", | ||
| "@aws-sdk/property-provider": "3.27.0", | ||
| "@aws-sdk/shared-ini-file-loader": "3.23.0", | ||
@@ -27,0 +27,0 @@ "@aws-sdk/types": "3.25.0", |
@@ -6,59 +6,7 @@ # @aws-sdk/credential-provider-process | ||
| ## AWS Credential Provider for Node.JS - Shared Configuration Files | ||
| > An internal package | ||
| 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](#sample-files) below for examples of well-formed configuration and | ||
| credentials files. | ||
| ## Usage | ||
| 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 the `AWS_PROFILE` environment variable or a default of | ||
| `default`. | ||
| - `filepath` - The path to the shared credentials file. If not specified, the | ||
| provider will use the value in the `AWS_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 the `AWS_CONFIG_FILE` environment variable or a | ||
| default of `~/.aws/config`. | ||
| ## Sample files | ||
| ### `~/.aws/credentials` | ||
| ```ini | ||
| [default] | ||
| credential_process = /usr/local/bin/awscreds | ||
| [dev] | ||
| credential_process = /usr/local/bin/awscreds dev | ||
| [prod] | ||
| credential_process = /usr/local/bin/awscreds prod | ||
| ``` | ||
| ### `~/.aws/config` | ||
| ```ini | ||
| [default] | ||
| credential_process = /usr/local/bin/awscreds | ||
| [profile dev] | ||
| credential_process = /usr/local/bin/awscreds dev | ||
| [profile prod] | ||
| credential_process = /usr/local/bin/awscreds prod | ||
| ``` | ||
| You probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers) | ||
| instead. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-2.27%
66022
- Number of lines in readme file
- decreased by-81.25%
12
Dependency changes
+ Added@aws-sdk/property-provider@3.27.0(transitive)
- Removed@aws-sdk/property-provider@3.25.0(transitive)