Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 4, 2024
1 parent bd079ae commit 3cec20e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Terraform module for AWS RDS instances
| <a name="input_is_cluster"></a> [is\_cluster](#input\_is\_cluster) | [Experiemental Feature] Specify whether or not to deploy the instance as multi-az database cluster.<br> Valid Values: .<br> Notes:<br> - This feature is currently in beta and is subject to change.<br> - It creates a DB cluster with a primary DB instance and two readable standby DB instances,<br> - Each DB instance in a different Availability Zone (AZ).<br> - Provides high availability, data redundancy and increases capacity to serve read workloads<br> - Proxy is not supported for cluster instances.<br> - For smaller workloads we recommend considering using a single instance instead of a cluster. | `bool` | `false` | no |
| <a name="input_is_kubernetes_app_enabled"></a> [is\_kubernetes\_app\_enabled](#input\_is\_kubernetes\_app\_enabled) | Specify whether or not to enable access from Kubernetes pods.<br> Valid Values: .<br> Notes: Enabling this will create the following resources:<br> - IAM role for service account (IRSA)<br> - IAM policy for service account (IRSA) | `bool` | `false` | no |
| <a name="input_is_proxy_included"></a> [is\_proxy\_included](#input\_is\_proxy\_included) | Specify whether or not to include proxy.<br> Valid Values: .<br> Notes: Proxy helps managing database connections. See [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-planning.html) for more information. | `bool` | `false` | no |
| <a name="input_is_publicly_accessible"></a> [is\_publicly\_accessible](#input\_is\_publicly\_accessible) | Specify whether or not this instance is publicly accessible.<br> Valid Values: .<br> Notes:<br> - Setting this to true will do the followings:<br> - Assign a public IP address and the host name of the DB instance will resolve to the public IP address.<br> - Access from within the VPC can be achived by using the private IP address of the assigned Network Interface. | `bool` | `false` | no |
| <a name="input_maintenance_window"></a> [maintenance\_window](#input\_maintenance\_window) | Specify the window to perform maintenance in.<br> Valid Values: Syntax: `ddd:hh24:mi-ddd:hh24:mi`. Eg: `"Mon:00:00-Mon:03:00"`.<br> Notes: Default value is set to `"Sat:18:00-Sat:20:00"`. This is adjusted in accordance with AWS Backup schedule, see info [here](https://wiki.dfds.cloud/en/playbooks/aws-backup/aws-backup-getting-started). | `string` | `"Sat:18:00-Sat:20:00"` | no |
| <a name="input_manage_master_user_password"></a> [manage\_master\_user\_password](#input\_manage\_master\_user\_password) | Set to true to allow RDS to manage the master user password in Secrets Manager<br> Valid Values: .<br> Notes:<br> - Default value is set to true. It is recommended to use this feature.<br> - If set to true, the `password` variable will be ignored. | `bool` | `true` | no |
| <a name="input_max_allocated_storage"></a> [max\_allocated\_storage](#input\_max\_allocated\_storage) | Set the value to enable Storage Autoscaling and to set the max allocated storage.<br> Valid Values: .<br> Notes:<br> - If this variable is omitted:<br> - This value is set to 50 by default for production environments.<br> - This value is set to 0 by default for non-production environments. | `number` | `null` | no |
Expand All @@ -115,7 +116,6 @@ Terraform module for AWS RDS instances
| <a name="input_proxy_idle_client_timeout"></a> [proxy\_idle\_client\_timeout](#input\_proxy\_idle\_client\_timeout) | Specify idle client timeout of the RDS proxy (keep connection alive).<br> Valid Values: .<br> Notes: . | `number` | `1800` | no |
| <a name="input_proxy_require_tls"></a> [proxy\_require\_tls](#input\_proxy\_require\_tls) | Specify whether or not to require TLS for the proxy.<br> Valid Values: .<br> Notes: Default value is set to true. | `bool` | `true` | no |
| <a name="input_proxy_security_group_rules"></a> [proxy\_security\_group\_rules](#input\_proxy\_security\_group\_rules) | Specify additional security group rules for the RDS proxy.<br> Valid Values: .<br> Notes:<br> - Only ingress(inbound) rules are supported.<br> - Ingress rules are set to "Allow outbound traffic to PostgreSQL instance"<br> – Ingress rules are set to "Allow inbound traffic from same security group on specified database port" | <pre>object({<br> ingress_rules = list(any)<br> ingress_with_self = optional(list(any), [])<br> })</pre> | <pre>{<br> "ingress_rules": []<br>}</pre> | no |
| <a name="input_publicly_accessible"></a> [publicly\_accessible](#input\_publicly\_accessible) | Specify whether or not this instance is publicly accessible.<br> Valid Values: .<br> Notes:<br> - Setting this to true will do the followings:<br> - Assign a public IP address and the host name of the DB instance will resolve to the public IP address.<br> - Access from within the VPC can be achived by using the private IP address of the assigned Network Interface. | `bool` | `false` | no |
| <a name="input_rds_security_group_rules"></a> [rds\_security\_group\_rules](#input\_rds\_security\_group\_rules) | Specify additional security group rules for the RDS instance.<br> Valid Values: .<br> Notes: . | <pre>object({<br> ingress_rules = list(any)<br> ingress_with_self = optional(list(any), [])<br> egress_rules = optional(list(any), [])<br> })</pre> | n/a | yes |
| <a name="input_replicate_source_db"></a> [replicate\_source\_db](#input\_replicate\_source\_db) | Inidicate that this resource is a Replicate database, and to use this value as the source database.<br> Valid Values: The identifier of another Amazon RDS Database to replicate in the same region.<br> Notes: In case of cross-region replication, specify the ARN of the source DB instance. | `string` | `null` | no |
| <a name="input_resource_owner_contact_email"></a> [resource\_owner\_contact\_email](#input\_resource\_owner\_contact\_email) | Provide an email address for the resource owner (e.g. team or individual).<br> Valid Values: .<br> Notes: This set the dfds.owner tag. See recommendations [here](https://wiki.dfds.cloud/en/playbooks/standards/tagging_policy). | `string` | `null` | no |
Expand Down

0 comments on commit 3cec20e

Please sign in to comment.