Skip to content

Commit 51f5560

Browse files
authored
Merge pull request #1415 from aws-actions/lehmanmj-patch-1
chore: Update README.md
2 parents 59b4418 + d343995 commit 51f5560

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ See [action.yml](./action.yml) for more detail.
143143
| role-skip-session-tagging | Skips session tagging if set. | No |
144144
| inline-session-policy | You may further restrict the assumed role policy by defining an inline policy here. | No |
145145
| managed-session-policies | You may further restrict the assumed role policy by specifying a managed policy here. | No |
146-
| output-credentials | When set, outputs fetched credentials as action step output. (Outputs aws-access-key-id, aws-secret-access-key, aws-session-token, aws-account-id, and aws-expiration). Defaults to false. | No |
146+
| output-credentials | When set, outputs fetched credentials as action step output. (Outputs aws-access-key-id, aws-secret-access-key, aws-session-token, aws-account-id, authenticated-arn, and aws-expiration). Defaults to false. | No |
147147
| output-env-credentials | When set, outputs fetched credentials as environment variables (AWS_REGION, AWS_DEFAULT_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN). Defaults to true. Set to false if you need to avoid setting/changing env variables. You'd probably want to use output-credentials if you disable this. (NOTE: Setting to false will prevent the aws-account-id from being exported as a step output). | No |
148148
| unset-current-credentials | When set, attempts to unset any existing credentials in your action runner. | No |
149149
| disable-retry | Disabled retry/backoff logic for assume role calls. By default, retries are enabled. | No |
@@ -178,7 +178,7 @@ this action will always consider the `HTTP_PROXY` environment variable.
178178

179179
Manually configured proxy:
180180
```yaml
181-
uses: aws-actions/configure-aws-credentials@v4.2.1
181+
uses: aws-actions/configure-aws-credentials@v4.3.0
182182
with:
183183
aws-region: us-east-2
184184
role-to-assume: my-github-actions-role
@@ -249,13 +249,13 @@ line.
249249
<summary>Inline session policy examples</summary>
250250

251251
```yaml
252-
uses: aws-actions/configure-aws-credentials@v4.2.1
252+
uses: aws-actions/configure-aws-credentials@v4.3.0
253253
with:
254254
inline-session-policy: '{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:List*","Resource":"*"}]}'
255255
```
256256
Or we can have a nicely formatted JSON as well:
257257
```yaml
258-
uses: aws-actions/configure-aws-credentials@v4.2.1
258+
uses: aws-actions/configure-aws-credentials@v4.3.0
259259
with:
260260
inline-session-policy: >-
261261
{
@@ -281,13 +281,13 @@ the role.
281281
<summary>Managed session policy examples</summary>
282282

283283
```yaml
284-
uses: aws-actions/configure-aws-credentials@v4.2.1
284+
uses: aws-actions/configure-aws-credentials@v4.3.0
285285
with:
286286
managed-session-policies: arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
287287
```
288288
And we can pass multiple managed policies likes this:
289289
```yaml
290-
uses: aws-actions/configure-aws-credentials@v4.2.1
290+
uses: aws-actions/configure-aws-credentials@v4.3.0
291291
with:
292292
managed-session-policies: |
293293
arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
@@ -325,7 +325,7 @@ You can specify the audience through the `audience` input:
325325

326326
```yaml
327327
- name: Configure AWS Credentials for China region audience
328-
uses: aws-actions/configure-aws-credentials@v4.2.1
328+
uses: aws-actions/configure-aws-credentials@v4.3.0
329329
with:
330330
audience: sts.amazonaws.com.cn
331331
aws-region: cn-northwest-1
@@ -399,7 +399,7 @@ Examples
399399
### AssumeRoleWithWebIdentity
400400
```yaml
401401
- name: Configure AWS Credentials
402-
uses: aws-actions/configure-aws-credentials@v4.2.1
402+
uses: aws-actions/configure-aws-credentials@v4.3.0
403403
with:
404404
aws-region: us-east-2
405405
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
@@ -413,13 +413,13 @@ environment variable and use it to assume the role
413413
### AssumeRole with role previously assumed by action in same workflow
414414
```yaml
415415
- name: Configure AWS Credentials
416-
uses: aws-actions/configure-aws-credentials@v4.2.1
416+
uses: aws-actions/configure-aws-credentials@v4.3.0
417417
with:
418418
aws-region: us-east-2
419419
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
420420
role-session-name: MySessionName
421421
- name: Configure other AWS Credentials
422-
uses: aws-actions/configure-aws-credentials@v4.2.1
422+
uses: aws-actions/configure-aws-credentials@v4.3.0
423423
with:
424424
aws-region: us-east-2
425425
role-to-assume: arn:aws:iam::987654321000:role/my-second-role
@@ -434,7 +434,7 @@ role, `arn:aws:iam::987654321000:role/my-second-role`.
434434
### AssumeRole with static IAM credentials in repository secrets
435435
```yaml
436436
- name: Configure AWS Credentials
437-
uses: aws-actions/configure-aws-credentials@v4.2.1
437+
uses: aws-actions/configure-aws-credentials@v4.3.0
438438
with:
439439
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
440440
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -453,7 +453,7 @@ name, like `role-to-assume: my-github-actions-role`.
453453
```yaml
454454
- name: Configure AWS Credentials 1
455455
id: creds
456-
uses: aws-actions/configure-aws-credentials@v4.2.1
456+
uses: aws-actions/configure-aws-credentials@v4.3.0
457457
with:
458458
aws-region: us-east-2
459459
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
@@ -462,7 +462,7 @@ name, like `role-to-assume: my-github-actions-role`.
462462
run: |
463463
aws sts get-caller-identity
464464
- name: Configure AWS Credentials 2
465-
uses: aws-actions/configure-aws-credentials@v4.2.1
465+
uses: aws-actions/configure-aws-credentials@v4.3.0
466466
with:
467467
aws-region: us-east-2
468468
aws-access-key-id: ${{ steps.creds.outputs.aws-access-key-id }}

0 commit comments

Comments
 (0)