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

docs(credential-provider-node): behavior when roleAssumer is not provided #1950

Merged
merged 2 commits into from
Aug 17, 2023
Merged

docs(credential-provider-node): behavior when roleAssumer is not provided #1950

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f61b95
Update README.md
dmattia Jan 22, 2021
73baaeb
Merge branch 'main' into patch-1
trivikr Aug 17, 2023
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
4 changes: 2 additions & 2 deletions packages/credential-provider-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ supported:
code and `mfaCodeProvider` is not a valid function, the credential provider
promise will be rejected.
- `roleAssumer` - A function that assumes a role and returns a promise
fulfilled with credentials for the assumed role. If not specified, the SDK
will create an STS client and call its `assumeRole` method.
fulfilled with credentials for the assumed role. If not specified, no role
will be assumed, and an error will be thrown.
- `roleArn` - ARN to assume. If not specified, the provider will use the value
in the `AWS_ROLE_ARN` environment variable.
- `webIdentityTokenFile` - File location of where the `OIDC` token is stored.
Expand Down