Skip to content

Commit 32eb1b4

Browse files
feat: document mask-aws-account-id input (#606)
Closes #304 Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
1 parent 6ca2577 commit 32eb1b4

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,17 @@ In this example, the audience has been changed from the default to use a differe
139139

140140
Changing the default audience may be necessary when using non-default [AWS partitions](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
141141

142+
```yaml
143+
- name: Configure AWS Credentials
144+
uses: aws-actions/configure-aws-credentials@v1
145+
with:
146+
aws-region: us-east-2
147+
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
148+
role-session-name: MySessionName
149+
mask-aws-account-id: false
150+
```
151+
In this example, account ID masking has been disabled. By default, the AWS account ID will be obscured in the action's output. This may be helpful when debugging action failures.
152+
142153
### Sample IAM Role CloudFormation Template
143154
```yaml
144155
Parameters:

0 commit comments

Comments
 (0)