Cloud Spanner Instance Configuration

A Cloud Spanner Instance Configuration in Google Cloud defines the geographic placement and replication settings for Spanner instances. It determines where data is stored and how it is replicated across regions to balance latency, availability, and durability. Users choose between regional and multi-regional configurations based on performance and resilience needs.

gcp.spanner_instance_config

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
base_configcorestringBase configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.
config_typecorestringOutput only. Whether this instance configuration is a Google-managed or user-managed configuration.
datadog_display_namecorestring
etagcorestringetag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.
free_instance_availabilitycorestringOutput only. Describes whether free instances are available to be created in this instance configuration.
gcp_display_namecorestringThe name of this instance configuration as it appears in UIs.
labelscorearray<string>Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
leader_optionscorearray<string>Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
namecorestringA unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.
optional_replicascorejsonOutput only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
quorum_typecorestringOutput only. The `QuorumType` of the instance configuration.
reconcilingcoreboolOutput only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.
region_idcorestring
replicascorejsonThe geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
resource_namecorestring
statecorestringOutput only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.
storage_limit_per_processing_unitcoreint64Output only. The storage limit in bytes per processing unit.
tagscorehstore_csv
zone_idcorestring