Skip to content

Commit

Permalink
docs(credential-providers): update fromNodeProviderChain.ts docblock (#…
Browse files Browse the repository at this point in the history
…6086)

Clarify documentation on how init properties are used in fromNodeProviderChain
  • Loading branch information
DavidSouther committed Jul 17, 2024
1 parent e970376 commit 497105f
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion packages/credential-providers/src/fromNodeProviderChain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,15 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
* // const { fromNodeProviderChain } = require("@aws-sdk/credential-providers") // CommonJS import
*
* const credentialProvider = fromNodeProviderChain({
* //...any input of fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
* // init properties for fromEnv(), fromSSO(), fromTokenFile(), fromIni(),
* // fromProcess(), fromInstanceMetadata(), fromContainerMetadata()
*
* // For instance, to ignore the ini shared cache, change the credentials filepath for all
* // providers, and set the sso start id:
* ignoreCache: true,
* filepath: "~/.config/aws/credentials",
* ssoStartUrl: "https://d-abc123.awsapps.com/start"
*
* // Optional. Custom STS client configurations overriding the default ones.
* clientConfig: { region },
* // Optional. Custom STS client middleware plugin to modify the client default behavior.
Expand Down

0 comments on commit 497105f

Please sign in to comment.