File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed
packages/credential-provider-assume-role Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -15,8 +15,8 @@ The function `fromTokenFile` returns `CredentialProvider` that reads credentials
15
15
- Reads IAM role wanting to be assumed from either environment or config file paramters.
16
16
- Reads optional role session name to be used to distinguish sessions from either environment or config file paramters.
17
17
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.
20
20
- Uses credentials of source_profile to assume the role specified if specified.
21
21
22
22
| ** Environment Variable** | ** Config Variable** | ** Required** | ** Description** |
@@ -39,9 +39,11 @@ The following options are supported:
39
39
provider will use the value in the ` AWS_CONFIG_FILE ` environment variable or
40
40
` ~/.aws/config ` by default.
41
41
- ` 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.
43
44
- ` 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.
45
47
46
48
### Examples
47
49
You can’t perform that action at this time.
0 commit comments