Skip to content

Commit bb0d0ba

Browse files
committed
Improve description of GitHub OIDC claims variable
1 parent 0a47f9a commit bb0d0ba

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

variables.tf

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,13 @@ variable "aws_iam_role_separator" {
3030
}
3131

3232
variable "github_custom_claim" {
33-
description = "Custom OIDC claim for more specific access scope within a repository"
33+
description = <<-DESCRIPTION
34+
Custom OIDC claim for more specific access scope within the repository.
35+
The claim will be appended to the repo name, like "repo:repo-owner/repo-name:$${var.github_custom_claim}".
36+
For more details on what can be specified in this claim, see the
37+
[OIDC reference docs](https://docs.github.com/en/actions/reference/security/oidc) and
38+
[OIDC how-to for AWS](https://docs.github.com/en/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws).
39+
DESCRIPTION
3440
type = string
3541
default = "*"
3642
}

0 commit comments

Comments
 (0)