Update documentation

Orbitalize · Dec 8, 2023 · 3b53cdd · 3b53cdd
1 parent 1a2f570
commit 3b53cdd
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 11 deletions.
diff --git a/deploy/infrastructure/dependencies/terraform-aws-kubernetes/variables.tf b/deploy/infrastructure/dependencies/terraform-aws-kubernetes/variables.tf
@@ -36,12 +36,13 @@ variable "aws_route53_zone_id" {
 variable "aws_iam_permissions_boundary" {
   type        = string
   description = <<-EOT
-    AWS IAM Policy to be used for permissions boundaries on created roles.
+    AWS IAM Policy ARN to be used for permissions boundaries on created roles.
 
-    Example: `GithubCIPermissionBoundaries`
+    Example: `arn:aws:iam::123456789012:policy/GithubCIPermissionBoundaries`
   EOT
 }
 
+
 variable "app_hostname" {
   type        = string
   description = <<-EOT

diff --git a/deploy/infrastructure/modules/terraform-aws-dss/TFVARS.md b/deploy/infrastructure/modules/terraform-aws-dss/TFVARS.md
@@ -44,9 +44,9 @@ Example: `Z0123456789ABCDEFGHIJ`
 
 *Type: `string`*
 
-AWS IAM Policy to be used for permissions boundaries on created roles.
+AWS IAM Policy ARN to be used for permissions boundaries on created roles.
 
-Example: `GithubCIPermissionBoundaries`
+Example: `arn:aws:iam::123456789012:policy/GithubCIPermissionBoundaries`
 
 
 ### app_hostname

diff --git a/deploy/infrastructure/modules/terraform-aws-dss/variables.tf b/deploy/infrastructure/modules/terraform-aws-dss/variables.tf
@@ -36,12 +36,13 @@ variable "aws_route53_zone_id" {
 variable "aws_iam_permissions_boundary" {
   type        = string
   description = <<-EOT
-    AWS IAM Policy to be used for permissions boundaries on created roles.
+    AWS IAM Policy ARN to be used for permissions boundaries on created roles.
 
-    Example: `GithubCIPermissionBoundaries`
+    Example: `arn:aws:iam::123456789012:policy/GithubCIPermissionBoundaries`
   EOT
 }
 
+
 variable "app_hostname" {
   type        = string
   description = <<-EOT

diff --git a/deploy/infrastructure/utils/definitions/aws_iam_permissions_boundary.tf b/deploy/infrastructure/utils/definitions/aws_iam_permissions_boundary.tf
@@ -1,8 +1,8 @@
 variable "aws_iam_permissions_boundary" {
   type        = string
   description = <<-EOT
-    AWS IAM Policy to be used for permissions boundaries on created roles.
+    AWS IAM Policy ARN to be used for permissions boundaries on created roles.
 
-    Example: `GithubCIPermissionBoundaries`
+    Example: `arn:aws:iam::123456789012:policy/GithubCIPermissionBoundaries`
   EOT
-}
+}
diff --git a/deploy/operations/ci/aws-1/variables.tf b/deploy/operations/ci/aws-1/variables.tf
@@ -36,12 +36,13 @@ variable "aws_route53_zone_id" {
 variable "aws_iam_permissions_boundary" {
   type        = string
   description = <<-EOT
-    AWS IAM Policy to be used for permissions boundaries on created roles.
+    AWS IAM Policy ARN to be used for permissions boundaries on created roles.
 
-    Example: `GithubCIPermissionBoundaries`
+    Example: `arn:aws:iam::123456789012:policy/GithubCIPermissionBoundaries`
   EOT
 }
 
+
 variable "app_hostname" {
   type        = string
   description = <<-EOT