|
|
|
@ -146,28 +146,29 @@ module "db" {
|
|
|
|
|
|
|
|
|
|
| name | description | type | required | default |
|
|
|
|
|
|---|---|:---:|:---:|:---:|
|
|
|
|
|
| [database_version](variables.tf#L49) | Database type and version to create. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L102) | Name of primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [network](variables.tf#L107) | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | <code>string</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L128) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
|
|
|
|
| [region](variables.tf#L133) | Region of the primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [tier](variables.tf#L153) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
|
|
|
|
| [authorized_networks](variables.tf#L17) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [availability_type](variables.tf#L23) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"ZONAL"</code> |
|
|
|
|
|
| [backup_configuration](variables.tf#L29) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | <code title="object({ enabled = bool binary_log_enabled = bool start_time = string location = string log_retention_days = number retention_count = number })">object({…})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = null log_retention_days = 7 retention_count = 7 }">{…}</code> |
|
|
|
|
|
| [databases](variables.tf#L54) | Databases to create once the primary instance is created. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [deletion_protection](variables.tf#L60) | Allow terraform to delete instances. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [disk_size](variables.tf#L66) | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [disk_type](variables.tf#L72) | The type of data disk: `PD_SSD` or `PD_HDD`. | <code>string</code> | | <code>"PD_SSD"</code> |
|
|
|
|
|
| [encryption_key_name](variables.tf#L78) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [flags](variables.tf#L84) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [ipv4_enabled](variables.tf#L90) | Add a public IP address to database instance. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [labels](variables.tf#L96) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [postgres_client_certificates](variables.tf#L112) | Map of cert keys connect to the application(s) using public IP. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [prefix](variables.tf#L118) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [replicas](variables.tf#L138) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | <code title="map(object({ region = string encryption_key_name = string }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [root_password](variables.tf#L147) | Root password of the Cloud SQL instance. Required for MS SQL Server. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [users](variables.tf#L158) | Map of users to create in the primary instance (and replicated to other replicas) in the format USER=>PASSWORD. For MySQL, anything afterr the first `@` (if persent) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [database_version](variables.tf#L58) | Database type and version to create. | <code>string</code> | ✓ | |
|
|
|
|
|
| [name](variables.tf#L111) | Name of primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [network](variables.tf#L116) | VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC. | <code>string</code> | ✓ | |
|
|
|
|
|
| [project_id](variables.tf#L137) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
|
|
|
|
| [region](variables.tf#L142) | Region of the primary instance. | <code>string</code> | ✓ | |
|
|
|
|
|
| [tier](variables.tf#L162) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
|
|
|
|
| [allocated_ip_ranges](variables.tf#L17) | (Optional)The name of the allocated ip range for the private ip CloudSQL instance. For example: \"google-managed-services-default\". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. | <code title="object({ primary = optional(string) replica = optional(string) })">object({…})</code> | | <code>{}</code> |
|
|
|
|
|
| [authorized_networks](variables.tf#L26) | Map of NAME=>CIDR_RANGE to allow to connect to the database(s). | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [availability_type](variables.tf#L32) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"ZONAL"</code> |
|
|
|
|
|
| [backup_configuration](variables.tf#L38) | Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas. | <code title="object({ enabled = bool binary_log_enabled = bool start_time = string location = string log_retention_days = number retention_count = number })">object({…})</code> | | <code title="{ enabled = false binary_log_enabled = false start_time = "23:00" location = null log_retention_days = 7 retention_count = 7 }">{…}</code> |
|
|
|
|
|
| [databases](variables.tf#L63) | Databases to create once the primary instance is created. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [deletion_protection](variables.tf#L69) | Allow terraform to delete instances. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [disk_size](variables.tf#L75) | Disk size in GB. Set to null to enable autoresize. | <code>number</code> | | <code>null</code> |
|
|
|
|
|
| [disk_type](variables.tf#L81) | The type of data disk: `PD_SSD` or `PD_HDD`. | <code>string</code> | | <code>"PD_SSD"</code> |
|
|
|
|
|
| [encryption_key_name](variables.tf#L87) | The full path to the encryption key used for the CMEK disk encryption of the primary instance. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [flags](variables.tf#L93) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [ipv4_enabled](variables.tf#L99) | Add a public IP address to database instance. | <code>bool</code> | | <code>false</code> |
|
|
|
|
|
| [labels](variables.tf#L105) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
| [postgres_client_certificates](variables.tf#L121) | Map of cert keys connect to the application(s) using public IP. | <code>list(string)</code> | | <code>null</code> |
|
|
|
|
|
| [prefix](variables.tf#L127) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [replicas](variables.tf#L147) | Map of NAME=> {REGION, KMS_KEY} for additional read replicas. Set to null to disable replica creation. | <code title="map(object({ region = string encryption_key_name = string }))">map(object({…}))</code> | | <code>{}</code> |
|
|
|
|
|
| [root_password](variables.tf#L156) | Root password of the Cloud SQL instance. Required for MS SQL Server. | <code>string</code> | | <code>null</code> |
|
|
|
|
|
| [users](variables.tf#L167) | Map of users to create in the primary instance (and replicated to other replicas) in the format USER=>PASSWORD. For MySQL, anything afterr the first `@` (if persent) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. | <code>map(string)</code> | | <code>null</code> |
|
|
|
|
|
|
|
|
|
|
## Outputs
|
|
|
|
|
|
|
|
|
|