From 7eed8f0559b7f4bffc26d95929a2479f049a0239 Mon Sep 17 00:00:00 2001 From: Omar Valenzuela <51972068+valenzuelaomar@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:05:54 -0700 Subject: [PATCH] fix: update READMEs for aws-aurora, aws-aurora-postgres, aws-aurora-mysql (#626) * update readmes * remove space --- aws-aurora-mysql/README.md | 1 + aws-aurora-mysql/variables.tf | 2 +- aws-aurora-postgres/README.md | 2 +- aws-aurora-postgres/variables.tf | 2 +- aws-aurora/README.md | 1 + aws-aurora/variables.tf | 2 +- 6 files changed, 6 insertions(+), 4 deletions(-) diff --git a/aws-aurora-mysql/README.md b/aws-aurora-mysql/README.md index 565051dd..2dc4e924 100644 --- a/aws-aurora-mysql/README.md +++ b/aws-aurora-mysql/README.md @@ -75,6 +75,7 @@ No resources. | [engine\_version](#input\_engine\_version) | The version of the engine to be used for aurora-mysql. | `string` | `"5.7"` | no | | [env](#input\_env) | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes | | [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | n/a | `string` | `false` | no | +| [iam\_roles](#input\_iam\roles) | A list of ARNs for the IAM roles to associate to the RDS Cluster. | `list(string)` | `[]` | no | | [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [ingress\_security\_groups](#input\_ingress\_security\_groups) | A list of security groups that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [instance\_class](#input\_instance\_class) | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Performance.html) | `string` | `"db.t2.small"` | no | diff --git a/aws-aurora-mysql/variables.tf b/aws-aurora-mysql/variables.tf index 0114d03e..ac248d47 100755 --- a/aws-aurora-mysql/variables.tf +++ b/aws-aurora-mysql/variables.tf @@ -166,7 +166,7 @@ variable "iam_database_authentication_enabled" { variable "iam_roles" { type = list(string) - description = "A list of IAM roles to associate with the RDS cluster." + description = "A list of ARNs for the IAM roles to associate to the RDS Cluster." default = [] } diff --git a/aws-aurora-postgres/README.md b/aws-aurora-postgres/README.md index 2d1141b6..762bc73e 100644 --- a/aws-aurora-postgres/README.md +++ b/aws-aurora-postgres/README.md @@ -17,7 +17,6 @@ module "db" { database_name = "..." database_subnet_group = "..." database_password = "..." - vpc_id = "..." ingress_cidr_blocks = "... @@ -66,6 +65,7 @@ No resources. | [engine\_version](#input\_engine\_version) | The version of Postgres to use. This should be a *prefix* if auto version upgrades are enabled. (Docs: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#engine_version) | `string` | `"10"` | no | | [env](#input\_env) | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes | | [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | n/a | `string` | `false` | no | +| [iam\_roles](#input\_iam\roles) | A list of ARNs for the IAM roles to associate to the RDS Cluster. | `list(string)` | `[]` | no | | [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [ingress\_security\_groups](#input\_ingress\_security\_groups) | A list of security groups that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [instance\_class](#input\_instance\_class) | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Managing.html) | `string` | `"db.r4.large"` | no | diff --git a/aws-aurora-postgres/variables.tf b/aws-aurora-postgres/variables.tf index fd1620a8..e4e68445 100755 --- a/aws-aurora-postgres/variables.tf +++ b/aws-aurora-postgres/variables.tf @@ -127,7 +127,7 @@ variable "iam_database_authentication_enabled" { variable "iam_roles" { type = list(string) - description = "A list of IAM roles to associate with the RDS cluster." + description = "A list of ARNs for the IAM roles to associate to the RDS Cluster." default = [] } diff --git a/aws-aurora/README.md b/aws-aurora/README.md index 1c03cf36..6b17465f 100644 --- a/aws-aurora/README.md +++ b/aws-aurora/README.md @@ -48,6 +48,7 @@ No modules. | [engine\_version](#input\_engine\_version) | n/a | `string` | n/a | yes | | [env](#input\_env) | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes | | [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. | `string` | `true` | no | +| [iam\_roles](#input\_iam\roles) | A list of ARNs for the IAM roles to associate to the RDS Cluster. | `list(string)` | `[]` | no | | [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [ingress\_security\_groups](#input\_ingress\_security\_groups) | A list of security groups that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no | | [instance\_class](#input\_instance\_class) | n/a | `string` | `"db.t2.small"` | no | diff --git a/aws-aurora/variables.tf b/aws-aurora/variables.tf index f6d90872..707702be 100755 --- a/aws-aurora/variables.tf +++ b/aws-aurora/variables.tf @@ -120,7 +120,7 @@ variable "iam_database_authentication_enabled" { variable "iam_roles" { type = list(string) - description = "A list of IAM roles to associate with the RDS cluster." + description = "A list of ARNs for the IAM roles to associate to the RDS Cluster." default = [] }