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

115 lines
3.5 KiB
HCL

/**
* Copyright 2023 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 "clusters" {
description = "Clusters to be created in the BigTable instance. Set more than one cluster to enable replication. If you set autoscaling, num_nodes will be ignored."
nullable = false
type = map(object({
zone = optional(string)
storage_type = optional(string)
num_nodes = optional(number)
autoscaling = optional(object({
min_nodes = number
max_nodes = number
cpu_target = number
storage_target = optional(number)
}))
}))
}
variable "default_autoscaling" {
description = "Default settings for autoscaling of clusters. This will be the default autoscaling for any cluster not specifying any autoscaling details."
type = object({
min_nodes = number
max_nodes = number
cpu_target = number
storage_target = optional(number)
})
default = null
}
variable "default_gc_policy" {
description = "Default garbage collection policy, to be applied to all column families and all tables. Can be override in the tables variable for specific column families."
type = object({
deletion_policy = optional(string)
gc_rules = optional(string)
mode = optional(string)
max_age = optional(string)
max_version = optional(string)
})
default = null
}
variable "deletion_protection" {
description = "Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail."
type = bool
default = true
nullable = false
}
variable "display_name" {
description = "The human-readable display name of the Bigtable instance."
type = string
default = null
}
variable "encryption_key" {
description = "The KMS key id to used for encryption of the Bigtable instance."
type = string
default = null
}
variable "iam" {
description = "IAM bindings for topic in {ROLE => [MEMBERS]} format."
type = map(list(string))
default = {}
}
variable "labels" {
description = "Labels to be attached to the instance."
type = map(string)
default = {}
}
variable "name" {
description = "The name of the Cloud Bigtable instance."
type = string
}
variable "project_id" {
description = "Id of the project where datasets will be created."
type = string
}
variable "tables" {
description = "Tables to be created in the BigTable instance."
nullable = false
type = map(object({
split_keys = optional(list(string), [])
column_families = optional(map(object(
{
gc_policy = optional(object({
deletion_policy = optional(string)
gc_rules = optional(string)
mode = optional(string)
max_age = optional(string)
max_version = optional(string)
}), null)
})), {})
}))
default = {}
}