Skip to content

Commit

Permalink
feat: document mask-aws-account-id input (#606)
Browse files Browse the repository at this point in the history
Closes #304

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
jacksonwelsh and mergify[bot] committed Feb 22, 2023
1 parent 6ca2577 commit 32eb1b4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,17 @@ In this example, the audience has been changed from the default to use a differe

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).

```yaml
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
role-session-name: MySessionName
mask-aws-account-id: false
```
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.

### Sample IAM Role CloudFormation Template
```yaml
Parameters:
Expand Down

0 comments on commit 32eb1b4

Please sign in to comment.