gcp_spanner_instance_config

ancestors

Type: UNORDERED_LIST_STRING

base_config

Type: STRING
Provider name: baseConfig
Description: Base 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_type

Type: STRING
Provider name: configType
Description: Output only. Whether this instance configuration is a Google-managed or user-managed configuration.
Possible values:

• TYPE_UNSPECIFIED - Unspecified.
  
• GOOGLE_MANAGED - Google-managed configuration.
  
• USER_MANAGED - User-managed configuration.
  

etag

Type: STRING
Provider name: etag
Description: etag 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_availability

Type: STRING
Provider name: freeInstanceAvailability
Description: Output only. Describes whether free instances are available to be created in this instance configuration.
Possible values:

• FREE_INSTANCE_AVAILABILITY_UNSPECIFIED - Not specified.
  
• AVAILABLE - Indicates that free instances are available to be created in this instance configuration.
  
• UNSUPPORTED - Indicates that free instances are not supported in this instance configuration.
  
• DISABLED - Indicates that free instances are currently not available to be created in this instance configuration.
  
• QUOTA_EXCEEDED - Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances.
  

gcp_display_name

Type: STRING
Provider name: displayName
Description: The name of this instance configuration as it appears in UIs.

labels

Type: UNORDERED_LIST_STRING

leader_options

Type: UNORDERED_LIST_STRING
Provider name: leaderOptions
Description: Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.

name

Type: STRING
Provider name: name
Description: A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*. User instance configuration must start with custom-.

optional_replicas

Type: UNORDERED_LIST_STRUCT
Provider name: optionalReplicas
Description: Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.

• default_leader_location
  Type: BOOLEAN
  Provider name: defaultLeaderLocation
  Description: If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
  
• location
  Type: STRING
  Provider name: location
  Description: The location of the serving resources, e.g., “us-central1”.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of replica.
  Possible values:
  
  • TYPE_UNSPECIFIED - Not specified.
    
  • READ_WRITE - Read-write replicas support both reads and writes. These replicas: * Maintain a full copy of your data. * Serve reads. * Can vote whether to commit a write. * Participate in leadership election. * Are eligible to become a leader.
    
  • READ_ONLY - Read-only replicas only support reads (not writes). Read-only replicas: * Maintain a full copy of your data. * Serve reads. * Do not participate in voting to commit writes. * Are not eligible to become a leader.
    
  • WITNESS - Witness replicas don’t support reads but do participate in voting to commit writes. Witness replicas: * Do not maintain a full copy of data. * Do not serve reads. * Vote whether to commit writes. * Participate in leader election but are not eligible to become leader.
    

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

quorum_type

Type: STRING
Provider name: quorumType
Description: Output only. The QuorumType of the instance configuration.
Possible values:

• QUORUM_TYPE_UNSPECIFIED - Quorum type not specified.
  
• REGION - An instance configuration tagged with REGION quorum type forms a write quorum in a single region.
  
• DUAL_REGION - An instance configuration tagged with the DUAL_REGION quorum type forms a write quorum with exactly two read-write regions in a multi-region configuration. This instance configuration requires failover in the event of regional failures.
  
• MULTI_REGION - An instance configuration tagged with the MULTI_REGION quorum type forms a write quorum from replicas that are spread across more than one region in a multi-region configuration.
  

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.

replicas

Type: UNORDERED_LIST_STRUCT
Provider name: replicas
Description: The 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.

• default_leader_location
  Type: BOOLEAN
  Provider name: defaultLeaderLocation
  Description: If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
  
• location
  Type: STRING
  Provider name: location
  Description: The location of the serving resources, e.g., “us-central1”.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of replica.
  Possible values:
  
  • TYPE_UNSPECIFIED - Not specified.
    
  • READ_WRITE - Read-write replicas support both reads and writes. These replicas: * Maintain a full copy of your data. * Serve reads. * Can vote whether to commit a write. * Participate in leadership election. * Are eligible to become a leader.
    
  • READ_ONLY - Read-only replicas only support reads (not writes). Read-only replicas: * Maintain a full copy of your data. * Serve reads. * Do not participate in voting to commit writes. * Are not eligible to become a leader.
    
  • WITNESS - Witness replicas don’t support reads but do participate in voting to commit writes. Witness replicas: * Do not maintain a full copy of data. * Do not serve reads. * Vote whether to commit writes. * Participate in leader election but are not eligible to become leader.
    

resource_name

Type: STRING

state

Type: STRING
Provider name: state
Description: Output only. The current instance configuration state. Applicable only for USER_MANAGED configurations.
Possible values:

• STATE_UNSPECIFIED - Not specified.
  
• CREATING - The instance configuration is still being created.
  
• READY - The instance configuration is fully created and ready to be used to create instances.
  

storage_limit_per_processing_unit

Type: INT64
Provider name: storageLimitPerProcessingUnit
Description: Output only. The storage limit in bytes per processing unit.

tags

Type: UNORDERED_LIST_STRING