REST Resource: projects.instanceConfigs

• Resource: InstanceConfig
  • JSON representation
• ReplicaInfo
  • JSON representation
• ReplicaType
• Methods

Resource: InstanceConfig

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

JSON representation
{ "name": string, "displayName": string, "replicas": [ { object (ReplicaInfo) } ] }

Fields
name	string A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
displayName	string The name of this instance configuration as it appears in UIs.
replicas[]	object (ReplicaInfo) The geographic placement of nodes in this instance configuration and their replication properties.

ReplicaInfo

JSON representation
{ "location": string, "type": enum (ReplicaType), "defaultLeaderLocation": boolean }

Fields
location	string The location of the serving resources, e.g. "us-central1".
type	enum (ReplicaType) The type of replica.
defaultLeaderLocation	boolean If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.

ReplicaType

Indicates the type of replica. See the replica types documentation for more details.

Enums
TYPE_UNSPECIFIED	Not specified.
READ_WRITE	sessions.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	sessions.read-only replicas only support reads (not writes). sessions.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.

Methods
get	Gets information about a particular instance configuration.
list	Lists the supported instance configurations for a given project.