From f532c5dffd432e222fb63afc55ec21de60b4af85 Mon Sep 17 00:00:00 2001 From: "cloudposse-releaser[bot]" <163353533+cloudposse-releaser[bot]@users.noreply.github.com> Date: Thu, 12 Jun 2025 08:31:17 +0000 Subject: [PATCH] chore: update README.md --- README.md | 9 +++++++-- src/README.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6bdd8b5..a560aad 100644 --- a/README.md +++ b/README.md @@ -221,6 +221,8 @@ Reploying the component should show no changes. For example, | Name | Type | |------|------| +| [aws_secretsmanager_secret.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | resource | +| [aws_secretsmanager_secret_version.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | resource | | [random_password.mysql_admin_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | | [random_pet.mysql_admin_user](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | | [random_pet.mysql_db_name](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | @@ -261,7 +263,8 @@ Reploying the component should show no changes. For example, | [mysql\_backup\_retention\_period](#input\_mysql\_backup\_retention\_period) | Number of days for which to retain backups | `number` | `3` | no | | [mysql\_backup\_window](#input\_mysql\_backup\_window) | Daily time range during which the backups happen | `string` | `"07:00-09:00"` | no | | [mysql\_cluster\_size](#input\_mysql\_cluster\_size) | MySQL cluster size | `string` | `2` | no | -| [mysql\_db\_name](#input\_mysql\_db\_name) | Database name (default is not to create a database | `string` | `""` | no | +| [mysql\_db\_name](#input\_mysql\_db\_name) | Database name (default is not to create a database) | `string` | `""` | no | +| [mysql\_db\_port](#input\_mysql\_db\_port) | Database port | `number` | `3306` | no | | [mysql\_deletion\_protection](#input\_mysql\_deletion\_protection) | Set to `true` to protect the database from deletion | `string` | `true` | no | | [mysql\_enabled\_cloudwatch\_logs\_exports](#input\_mysql\_enabled\_cloudwatch\_logs\_exports) | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery | `list(string)` |
[
"audit",
"error",
"general",
"slowquery"
]
| no | | [mysql\_instance\_type](#input\_mysql\_instance\_type) | EC2 instance type for RDS MySQL cluster | `string` | `"db.t3.medium"` | no | @@ -278,6 +281,7 @@ Reploying the component should show no changes. For example, | [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | | [region](#input\_region) | AWS Region | `string` | n/a | yes | | [replication\_source\_identifier](#input\_replication\_source\_identifier) | ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.
If this value is empty and replication is enabled, remote state will attempt to find
a matching cluster in the Primary DB Cluster's region | `string` | `""` | no | +| [secrets\_store\_type](#input\_secrets\_store\_type) | Secret Store type to save database credentials. Valid values: `SSM`, `ASM` | `string` | `"SSM"` | no | | [ssm\_password\_source](#input\_ssm\_password\_source) | If `var.ssm_passwords_enabled` is `true`, DB user passwords will be retrieved from SSM using
`var.ssm_password_source` and the database username. If this value is not set,
a default path will be created using the SSM path prefix and ID of the associated Aurora Cluster. | `string` | `""` | no | | [ssm\_path\_prefix](#input\_ssm\_path\_prefix) | SSM path prefix | `string` | `"rds"` | no | | [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | @@ -294,7 +298,8 @@ Reploying the component should show no changes. For example, | [aurora\_mysql\_cluster\_name](#output\_aurora\_mysql\_cluster\_name) | Aurora MySQL cluster identifier | | [aurora\_mysql\_endpoint](#output\_aurora\_mysql\_endpoint) | Aurora MySQL endpoint | | [aurora\_mysql\_master\_hostname](#output\_aurora\_mysql\_master\_hostname) | Aurora MySQL DB master hostname | -| [aurora\_mysql\_master\_password](#output\_aurora\_mysql\_master\_password) | Location of admin password in SSM | +| [aurora\_mysql\_master\_password](#output\_aurora\_mysql\_master\_password) | Location of admin password | +| [aurora\_mysql\_master\_password\_asm\_key](#output\_aurora\_mysql\_master\_password\_asm\_key) | ASM key for admin password | | [aurora\_mysql\_master\_password\_ssm\_key](#output\_aurora\_mysql\_master\_password\_ssm\_key) | SSM key for admin password | | [aurora\_mysql\_master\_username](#output\_aurora\_mysql\_master\_username) | Aurora MySQL username for the master DB user | | [aurora\_mysql\_reader\_endpoint](#output\_aurora\_mysql\_reader\_endpoint) | Aurora MySQL reader endpoint | diff --git a/src/README.md b/src/README.md index 23c7f8d..88a6053 100644 --- a/src/README.md +++ b/src/README.md @@ -201,6 +201,8 @@ Reploying the component should show no changes. For example, | Name | Type | |------|------| +| [aws_secretsmanager_secret.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret) | resource | +| [aws_secretsmanager_secret_version.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/secretsmanager_secret_version) | resource | | [random_password.mysql_admin_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | | [random_pet.mysql_admin_user](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | | [random_pet.mysql_db_name](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource | @@ -241,7 +243,8 @@ Reploying the component should show no changes. For example, | [mysql\_backup\_retention\_period](#input\_mysql\_backup\_retention\_period) | Number of days for which to retain backups | `number` | `3` | no | | [mysql\_backup\_window](#input\_mysql\_backup\_window) | Daily time range during which the backups happen | `string` | `"07:00-09:00"` | no | | [mysql\_cluster\_size](#input\_mysql\_cluster\_size) | MySQL cluster size | `string` | `2` | no | -| [mysql\_db\_name](#input\_mysql\_db\_name) | Database name (default is not to create a database | `string` | `""` | no | +| [mysql\_db\_name](#input\_mysql\_db\_name) | Database name (default is not to create a database) | `string` | `""` | no | +| [mysql\_db\_port](#input\_mysql\_db\_port) | Database port | `number` | `3306` | no | | [mysql\_deletion\_protection](#input\_mysql\_deletion\_protection) | Set to `true` to protect the database from deletion | `string` | `true` | no | | [mysql\_enabled\_cloudwatch\_logs\_exports](#input\_mysql\_enabled\_cloudwatch\_logs\_exports) | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery | `list(string)` |
[
"audit",
"error",
"general",
"slowquery"
]
| no | | [mysql\_instance\_type](#input\_mysql\_instance\_type) | EC2 instance type for RDS MySQL cluster | `string` | `"db.t3.medium"` | no | @@ -258,6 +261,7 @@ Reploying the component should show no changes. For example, | [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | | [region](#input\_region) | AWS Region | `string` | n/a | yes | | [replication\_source\_identifier](#input\_replication\_source\_identifier) | ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.
If this value is empty and replication is enabled, remote state will attempt to find
a matching cluster in the Primary DB Cluster's region | `string` | `""` | no | +| [secrets\_store\_type](#input\_secrets\_store\_type) | Secret Store type to save database credentials. Valid values: `SSM`, `ASM` | `string` | `"SSM"` | no | | [ssm\_password\_source](#input\_ssm\_password\_source) | If `var.ssm_passwords_enabled` is `true`, DB user passwords will be retrieved from SSM using
`var.ssm_password_source` and the database username. If this value is not set,
a default path will be created using the SSM path prefix and ID of the associated Aurora Cluster. | `string` | `""` | no | | [ssm\_path\_prefix](#input\_ssm\_path\_prefix) | SSM path prefix | `string` | `"rds"` | no | | [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | @@ -274,7 +278,8 @@ Reploying the component should show no changes. For example, | [aurora\_mysql\_cluster\_name](#output\_aurora\_mysql\_cluster\_name) | Aurora MySQL cluster identifier | | [aurora\_mysql\_endpoint](#output\_aurora\_mysql\_endpoint) | Aurora MySQL endpoint | | [aurora\_mysql\_master\_hostname](#output\_aurora\_mysql\_master\_hostname) | Aurora MySQL DB master hostname | -| [aurora\_mysql\_master\_password](#output\_aurora\_mysql\_master\_password) | Location of admin password in SSM | +| [aurora\_mysql\_master\_password](#output\_aurora\_mysql\_master\_password) | Location of admin password | +| [aurora\_mysql\_master\_password\_asm\_key](#output\_aurora\_mysql\_master\_password\_asm\_key) | ASM key for admin password | | [aurora\_mysql\_master\_password\_ssm\_key](#output\_aurora\_mysql\_master\_password\_ssm\_key) | SSM key for admin password | | [aurora\_mysql\_master\_username](#output\_aurora\_mysql\_master\_username) | Aurora MySQL username for the master DB user | | [aurora\_mysql\_reader\_endpoint](#output\_aurora\_mysql\_reader\_endpoint) | Aurora MySQL reader endpoint |