Skip to content

Commit

Permalink
add a description about use-node-id
Browse files Browse the repository at this point in the history
  • Loading branch information
shogo82148 committed Aug 17, 2021
1 parent c5b0b40 commit 075fb57
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,16 @@ The role's trust policy need extra permission `sts:TagSession` for session taggi
### Use the node id of the repository

You can use the global node id of the repository instead of its name as ExternalId.
By adding `use-node-id: true`, the action sends the node id (e.g. `MDEwOlJlcG9zaXRvcnkzNDg4NDkwMzk=`) as ExternalId.

```yaml
- uses: fuller-inc/actions-aws-assume-role@v1
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::123456789012:role/GitHubRepoRole-us-east-2
use-node-id: true
```

To get the node id, call [Get a repository REST API](https://docs.github.com/en/rest/reference/repos#get-a-repository).

```console
Expand Down

0 comments on commit 075fb57

Please sign in to comment.