Skip to content

Commit 497105f

Browse files
authored
docs(credential-providers): update fromNodeProviderChain.ts docblock (#6086)
Clarify documentation on how init properties are used in fromNodeProviderChain
1 parent e970376 commit 497105f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

packages/credential-providers/src/fromNodeProviderChain.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,15 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
1515
* // const { fromNodeProviderChain } = require("@aws-sdk/credential-providers") // CommonJS import
1616
*
1717
* const credentialProvider = fromNodeProviderChain({
18-
* //...any input of fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
18+
* // init properties for fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
1919
* // fromProcess(), fromInstanceMetadata(), fromContainerMetadata()
2020
*
21+
* // For instance, to ignore the ini shared cache, change the credentials filepath for all
22+
* // providers, and set the sso start id:
23+
* ignoreCache: true,
24+
* filepath: "~/.config/aws/credentials",
25+
* ssoStartUrl: "https://d-abc123.awsapps.com/start"
26+
*
2127
* // Optional. Custom STS client configurations overriding the default ones.
2228
* clientConfig: { region },
2329
* // Optional. Custom STS client middleware plugin to modify the client default behavior.

0 commit comments

Comments
 (0)