diff --git a/README.md b/README.md index e408c09..a59ded4 100644 --- a/README.md +++ b/README.md @@ -82,24 +82,22 @@ No modules. ## Inputs -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [attach\_admin\_policy](#input\_attach\_admin\_policy) | Flag to enable/disable the attachment of the AdministratorAccess policy. | `bool` | `false` | no | -| [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Flag to enable/disable the attachment of the ReadOnly policy. | `bool` | `true` | no | -| [create\_oidc\_provider](#input\_create\_oidc\_provider) | Flag to enable/disable the creation of the GitHub OIDC provider. | `bool` | `true` | no | -| [enabled](#input\_enabled) | Flag to enable/disable the creation of resources. | `bool` | `true` | no | -| [force\_detach\_policies](#input\_force\_detach\_policies) | Flag to force detachment of policies attached to the IAM role. | `string` | `false` | no | -| [github\_organisation](#input\_github\_organisation) | GitHub organisation name. | `string` | n/a | yes | -| [github\_repositories](#input\_github\_repositories) | List of GitHub repository names. | `list(string)` | n/a | yes | -| [github\_thumbprint](#input\_github\_thumbprint) | GitHub OpenID TLS certificate thumbprint. | `string` | `"6938fd4d98bab03faadb97b34396831e3780aea1"` | no | -| [iam\_policy\_name](#input\_iam\_policy\_name) | Name of the IAM policy to be assumed by GitHub. | `string` | `"github"` | no | -| [iam\_policy\_path](#input\_iam\_policy\_path) | Path to the IAM policy. | `string` | `"/"` | no | -| [iam\_role\_name](#input\_iam\_role\_name) | Name of the IAM role. | `string` | `"github"` | no | -| [iam\_role\_path](#input\_iam\_role\_path) | Path to the IAM role. | `string` | `"/"` | no | -| [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | ARN of the permissions boundary to be used by the IAM role. | `string` | `""` | no | -| [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs to attach to the IAM role. | `list(string)` | `[]` | no | -| [max\_session\_duration](#input\_max\_session\_duration) | Maximum session duration in seconds. | `number` | `3600` | no | -| [tags](#input\_tags) | Map of tags to be applied to all resources. | `map(string)` | `{}` | no | +| Name | Description | Type | Default | Required | +|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|------|---------|:--------:| +| [attach\_admin\_policy](#input\_attach\_admin\_policy) | Flag to enable/disable the attachment of the AdministratorAccess policy. | `bool` | `false` | no | +| [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Flag to enable/disable the attachment of the ReadOnly policy. | `bool` | `true` | no | +| [create\_oidc\_provider](#input\_create\_oidc\_provider) | Flag to enable/disable the creation of the GitHub OIDC provider. | `bool` | `true` | no | +| [enabled](#input\_enabled) | Flag to enable/disable the creation of resources. | `bool` | `true` | no | +| [force\_detach\_policies](#input\_force\_detach\_policies) | Flag to force detachment of policies attached to the IAM role. | `string` | `false` | no | +| [github\_organization](#input\_github\_organization) | GitHub organization name. | `string` | n/a | yes | +| [github\_repositories](#input\_github\_repositories) | List of GitHub repository names. | `list(string)` | n/a | yes | +| [github\_thumbprint](#input\_github\_thumbprint) | GitHub OpenID TLS certificate thumbprint. | `string` | `"6938fd4d98bab03faadb97b34396831e3780aea1"` | no | +| [iam\_role\_name](#input\_iam\_role\_name) | Name of the IAM role. | `string` | `"github"` | no | +| [iam\_role\_path](#input\_iam\_role\_path) | Path to the IAM role. | `string` | `"/"` | no | +| [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | ARN of the permissions boundary to be used by the IAM role. | `string` | `""` | no | +| [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs to attach to the IAM role. | `list(string)` | `[]` | no | +| [max\_session\_duration](#input\_max\_session\_duration) | Maximum session duration in seconds. | `number` | `3600` | no | +| [tags](#input\_tags) | Map of tags to be applied to all resources. | `map(string)` | `{}` | no | ## Outputs diff --git a/data.tf b/data.tf index dedeb07..41aaa27 100644 --- a/data.tf +++ b/data.tf @@ -23,7 +23,7 @@ data "aws_iam_policy_document" "assume_role" { condition { test = "StringLike" - values = [for repo in var.github_repositories : "repo:${var.github_organisation}/${repo}:*"] + values = [for repo in var.github_repositories : "repo:${var.github_organization}/${repo}:*"] variable = "token.actions.githubusercontent.com:sub" } diff --git a/examples/complete/main.tf b/examples/complete/main.tf index c79f71b..ab2028d 100644 --- a/examples/complete/main.tf +++ b/examples/complete/main.tf @@ -16,7 +16,7 @@ module "aws_oidc_github" { iam_role_path = var.iam_role_path iam_role_permissions_boundary = var.iam_role_permissions_boundary iam_role_policy_arns = var.iam_role_policy_arns - github_organisation = var.github_organisation + github_organization = var.github_organization github_repositories = var.github_repositories max_session_duration = var.max_session_duration tags = var.tags diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf index e65ee55..b62edde 100644 --- a/examples/complete/variables.tf +++ b/examples/complete/variables.tf @@ -28,8 +28,8 @@ variable "force_detach_policies" { type = string } -variable "github_organisation" { - description = "GitHub organisation name." +variable "github_organization" { + description = "GitHub organization name." type = string } diff --git a/main.tf b/main.tf index cd1c597..fc52a1b 100644 --- a/main.tf +++ b/main.tf @@ -22,7 +22,7 @@ resource "aws_iam_role" "github" { count = var.enabled ? 1 : 0 assume_role_policy = data.aws_iam_policy_document.assume_role[0].json - description = "Role used by the ${var.github_organisation} GitHub organisation." + description = "Role used by the ${var.github_organization} GitHub organization." force_detach_policies = var.force_detach_policies max_session_duration = var.max_session_duration name = var.iam_role_name @@ -55,7 +55,7 @@ resource "aws_iam_role_policy_attachment" "custom" { resource "aws_iam_openid_connect_provider" "github" { count = var.enabled && var.create_oidc_provider ? 1 : 0 - client_id_list = ["https://github.com/${var.github_organisation}", "sts.amazonaws.com"] + client_id_list = ["https://github.com/${var.github_organization}", "sts.amazonaws.com"] tags = var.tags thumbprint_list = [var.github_thumbprint] url = "https://token.actions.githubusercontent.com"