Skip to content

Commit dbbcac7

Browse files
trivikrAllanZhengYP
andcommitted
chore(docs): suggestions from code review
Co-authored-by: AllanZhengYP <[email protected]>
1 parent 8e87576 commit dbbcac7

File tree

1 file changed

+6
-4
lines changed
  • packages/credential-provider-assume-role

1 file changed

+6
-4
lines changed

packages/credential-provider-assume-role/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The function `fromTokenFile` returns `CredentialProvider` that reads credentials
1515
- Reads IAM role wanting to be assumed from either environment or config file paramters.
1616
- Reads optional role session name to be used to distinguish sessions from either environment or config file paramters.
1717
If session name is not defined, it comes up with a role session name.
18-
- Reads OIDC roken from file on disk.
19-
- Calls sts:AssumeRoleWithWebIdentity to get credentials.
18+
- Reads OIDC token from file on disk.
19+
- Calls sts:AssumeRoleWithWebIdentity via `roleAssumerWithWebIdentity` option to get credentials.
2020
- Uses credentials of source_profile to assume the role specified if specified.
2121

2222
| **Environment Variable** | **Config Variable** | **Required** | **Description** |
@@ -39,9 +39,11 @@ The following options are supported:
3939
provider will use the value in the `AWS_CONFIG_FILE` environment variable or
4040
`~/.aws/config` by default.
4141
- `roleAssumer` - A function that assumes a role and returns a promise
42-
fulfilled with credentials for the assumed role.
42+
fulfilled with credentials for the assumed role. You may call `sts:assumeRole`
43+
API within this function.
4344
- `roleAssumerWithWebIdentity` - A function that assumes a role with web identity
44-
and returns a promise fulfilled with credentials for the assumed role.
45+
and returns a promise fulfilled with credentials for the assumed role. You may call
46+
`sts:assumeRoleWithWebIdentity` API within this function.
4547

4648
### Examples
4749

0 commit comments

Comments
 (0)