Skip to content

Commit

Permalink
AWS IAM Role session name (#510)
Browse files Browse the repository at this point in the history
* AWS IAM Role session name

* fix typo
  • Loading branch information
suzuki-shunsuke authored Oct 18, 2024
1 parent 62e848f commit 7741cb1
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/config/tfaction-root-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,21 @@ target_groups:
enabled: true
terraform_plan_config:
aws_assume_role_arn: arn:aws:iam::000000000000:role/GitHubActions_Terraform_AWS_terraform_plan

# AWS IAM Role Session Name
# tfaction >= v1.11.0
# This is optional.
# The maximum length of the session name is 64.
# And it must satisfy regular expression pattern `[\w+=,.@-]*`.
# The default value of session name is
# 1. tfaction-{plan or apply}-{normalized target}-${GitHub Actions Run ID}
# 2. tfaction-{plan or apply}-{normalized target}
# 3. tfaction-{plan or apply}-${GitHub Actions Run ID}
# 4. tfaction-{plan or apply}
# / in the default targets are converted to `_`.
# And if target is too long, it is removed from the default session name.
aws_role_session_name: tfplan

tfmigrate_plan_config:
aws_assume_role_arn: arn:aws:iam::000000000000:role/GitHubActions_Terraform_AWS_tfmigrate_plan
terraform_apply_config:
Expand Down
15 changes: 15 additions & 0 deletions docs/config/tfaction-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ env:
secrets:
terraform_plan_config:
aws_assume_role_arn: arn:aws:iam::000000000000:role/GitHubActions_Terraform_AWS_terraform_plan

# AWS IAM Role Session Name
# tfaction >= v1.11.0
# This is optional.
# The maximum length of the session name is 64.
# And it must satisfy regular expression pattern `[\w+=,.@-]*`.
# The default value of session name is
# 1. tfaction-{plan or apply}-{normalized target}-${GitHub Actions Run ID}
# 2. tfaction-{plan or apply}-{normalized target}
# 3. tfaction-{plan or apply}-${GitHub Actions Run ID}
# 4. tfaction-{plan or apply}
# / in the default targets are converted to `_`.
# And if target is too long, it is removed from the default session name.
aws_role_session_name: tfplan

env:
# Environment variables
FOO: foo
Expand Down

0 comments on commit 7741cb1

Please sign in to comment.