Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update fromNodeProviderChain.ts docblock #6086

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Update fromNodeProviderChain.ts docblock #6086

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/credential-providers/src/fromNodeProviderChain.ts
View file
Open in desktop
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