cloud-foundation-fabric/modules/cloudsql-instance/variables.tf

133 lines
3.6 KiB
HCL

/**
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
variable "authorized_networks" {
description = "Map of NAME=>CIDR_RANGE to allow to connect to the database(s)."
type = map(string)
default = null
}
variable "availability_type" {
description = "Availability type for the primary replica. Either `ZONAL` or `REGIONAL`."
type = string
default = "ZONAL"
}
variable "backup_configuration" {
description = "Backup settings for primary instance. Will be automatically enabled if using MySQL with one or more replicas."
type = object({
enabled = bool
binary_log_enabled = bool
start_time = string
location = string
log_retention_days = number
retention_count = number
})
default = {
enabled = false
binary_log_enabled = false
start_time = "23:00"
location = "EU"
log_retention_days = 7
retention_count = 7
}
}
variable "database_version" {
description = "Database type and version to create."
type = string
}
variable "databases" {
description = "Databases to create once the primary instance is created."
type = list(string)
default = null
}
variable "deletion_protection" {
description = "Allow terraform to delete instances."
type = bool
default = false
}
variable "disk_size" {
description = "Disk size in GB. Set to null to enable autoresize."
type = number
default = null
}
variable "disk_type" {
description = "The type of data disk: `PD_SSD` or `PD_HDD`."
type = string
default = "PD_SSD"
}
variable "flags" {
description = "Map FLAG_NAME=>VALUE for database-specific tuning."
type = map(string)
default = null
}
variable "labels" {
description = "Labels to be attached to all instances."
type = map(string)
default = null
}
variable "name" {
description = "Name of primary replica."
type = string
}
variable "network" {
description = "VPC self link where the instances will be deployed. Private Service Networking must be enabled and configured in this VPC."
type = string
}
variable "prefix" {
description = "Prefix used to generate instance names."
type = string
default = null
}
variable "project_id" {
description = "The ID of the project where this instances will be created."
type = string
}
variable "region" {
description = "Region of the primary replica."
type = string
}
variable "replicas" {
description = "Map of NAME=>REGION for additional read replicas. Set to null to disable replica creation."
type = map(any)
default = null
}
variable "tier" {
description = "The machine type to use for the instances."
type = string
}
variable "users" {
description = "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."
type = map(string)
default = null
}