diff --git a/aws-aurora-postgres/README.md b/aws-aurora-postgres/README.md index 345fe563..2dc72d9b 100644 --- a/aws-aurora-postgres/README.md +++ b/aws-aurora-postgres/README.md @@ -55,14 +55,14 @@ No resources. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [apply\_immediately](#input\_apply\_immediately) | If false changes will not be applied until next maintenance window. | `string` | `false` | no | -| [auto\_minor\_version\_upgrade](#input\_auto\_minor\_version\_upgrade) | Set the databases to automatically upgrade minor versions. | `bool` | `true` | no | +| [auto\_minor\_version\_upgrade](#input\_auto\_minor\_version\_upgrade) | Set the databases to automatically upgrade minor versions. WARNING - if this is enabled, make sure engine_version is set to a *prefix* rather that a specific version so that TF won't try to downgrade DB's that have been auto-upgraded. Docs: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#engine_version | `bool` | `false` | no | | [ca\_cert\_identifier](#input\_ca\_cert\_identifier) | Identifier for the certificate authority. | `string` | `"rds-ca-2019"` | no | | [database\_name](#input\_database\_name) | The name of the database to be created in the cluster. | `string` | n/a | yes | | [database\_password](#input\_database\_password) | Password for user that will be created. | `string` | n/a | yes | | [database\_subnet\_group](#input\_database\_subnet\_group) | The name of an existing database subnet group to use. | `string` | n/a | yes | | [database\_username](#input\_database\_username) | Default user to be created. | `string` | n/a | yes | | [db\_parameters](#input\_db\_parameters) | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Reference.html#AuroraPostgreSQL.Reference.Parameters.Instance) | `list(any)` | `[]` | no | -| [engine\_version](#input\_engine\_version) | The version of Postgres to use. | `string` | `"10"` | no | +| [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 | | [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 | diff --git a/aws-aurora-postgres/variables.tf b/aws-aurora-postgres/variables.tf index 6aebf5fb..6e1898df 100755 --- a/aws-aurora-postgres/variables.tf +++ b/aws-aurora-postgres/variables.tf @@ -105,7 +105,7 @@ variable "kms_key_id" { variable "engine_version" { type = string - description = "The version of Postgres to use." + description = "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)" default = "10" } @@ -127,6 +127,6 @@ variable "ca_cert_identifier" { variable "auto_minor_version_upgrade" { type = bool - description = "Set the databases to automatically upgrade minor versions." - default = true + description = "Set the databases to automatically upgrade minor versions. WARNING - if this is enabled, make sure engine_version is set to a *prefix* rather that a specific version so that TF won't try to downgrade DB's that have been auto-upgraded. Docs: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#engine_version" + default = false }