Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. spanner
  5. spanner/v1
  6. InstanceConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.spanner/v1.InstanceConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, CreateInstanceConfig returns ALREADY_EXISTS. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config’s reconciling field is set to true. Its state is CREATING. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config’s reconciling field becomes false. Its state becomes READY. The returned long-running operation will have a name of the format /operations/ and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.create permission on the resource parent.

Create InstanceConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new InstanceConfig(name: string, args: InstanceConfigArgs, opts?: CustomResourceOptions);
@overload
def InstanceConfig(resource_name: str,
                   args: InstanceConfigArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def InstanceConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_config_id: Optional[str] = None,
                   base_config: Optional[str] = None,
                   display_name: Optional[str] = None,
                   etag: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   leader_options: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   replicas: Optional[Sequence[ReplicaInfoArgs]] = None,
                   validate_only: Optional[bool] = None)
func NewInstanceConfig(ctx *Context, name string, args InstanceConfigArgs, opts ...ResourceOption) (*InstanceConfig, error)
public InstanceConfig(string name, InstanceConfigArgs args, CustomResourceOptions? opts = null)
public InstanceConfig(String name, InstanceConfigArgs args)
public InstanceConfig(String name, InstanceConfigArgs args, CustomResourceOptions options)

type: google-native:spanner/v1:InstanceConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InstanceConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var instanceConfigResource = new GoogleNative.Spanner.V1.InstanceConfig("instanceConfigResource", new()
{
    InstanceConfigId = "string",
    BaseConfig = "string",
    DisplayName = "string",
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LeaderOptions = new[]
    {
        "string",
    },
    Name = "string",
    Project = "string",
    Replicas = new[]
    {
        new GoogleNative.Spanner.V1.Inputs.ReplicaInfoArgs
        {
            DefaultLeaderLocation = false,
            Location = "string",
            Type = GoogleNative.Spanner.V1.ReplicaInfoType.TypeUnspecified,
        },
    },
    ValidateOnly = false,
});
Copy
example, err := spanner.NewInstanceConfig(ctx, "instanceConfigResource", &spanner.InstanceConfigArgs{
	InstanceConfigId: pulumi.String("string"),
	BaseConfig:       pulumi.String("string"),
	DisplayName:      pulumi.String("string"),
	Etag:             pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LeaderOptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
	Replicas: spanner.ReplicaInfoArray{
		&spanner.ReplicaInfoArgs{
			DefaultLeaderLocation: pulumi.Bool(false),
			Location:              pulumi.String("string"),
			Type:                  spanner.ReplicaInfoTypeTypeUnspecified,
		},
	},
	ValidateOnly: pulumi.Bool(false),
})
Copy
var instanceConfigResource = new InstanceConfig("instanceConfigResource", InstanceConfigArgs.builder()
    .instanceConfigId("string")
    .baseConfig("string")
    .displayName("string")
    .etag("string")
    .labels(Map.of("string", "string"))
    .leaderOptions("string")
    .name("string")
    .project("string")
    .replicas(ReplicaInfoArgs.builder()
        .defaultLeaderLocation(false)
        .location("string")
        .type("TYPE_UNSPECIFIED")
        .build())
    .validateOnly(false)
    .build());
Copy
instance_config_resource = google_native.spanner.v1.InstanceConfig("instanceConfigResource",
    instance_config_id="string",
    base_config="string",
    display_name="string",
    etag="string",
    labels={
        "string": "string",
    },
    leader_options=["string"],
    name="string",
    project="string",
    replicas=[{
        "default_leader_location": False,
        "location": "string",
        "type": google_native.spanner.v1.ReplicaInfoType.TYPE_UNSPECIFIED,
    }],
    validate_only=False)
Copy
const instanceConfigResource = new google_native.spanner.v1.InstanceConfig("instanceConfigResource", {
    instanceConfigId: "string",
    baseConfig: "string",
    displayName: "string",
    etag: "string",
    labels: {
        string: "string",
    },
    leaderOptions: ["string"],
    name: "string",
    project: "string",
    replicas: [{
        defaultLeaderLocation: false,
        location: "string",
        type: google_native.spanner.v1.ReplicaInfoType.TypeUnspecified,
    }],
    validateOnly: false,
});
Copy
type: google-native:spanner/v1:InstanceConfig
properties:
    baseConfig: string
    displayName: string
    etag: string
    instanceConfigId: string
    labels:
        string: string
    leaderOptions:
        - string
    name: string
    project: string
    replicas:
        - defaultLeaderLocation: false
          location: string
          type: TYPE_UNSPECIFIED
    validateOnly: false
Copy

InstanceConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The InstanceConfig resource accepts the following input properties:

InstanceConfigId This property is required. string
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
BaseConfig string
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.
DisplayName string
The name of this instance configuration as it appears in UIs.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
Labels Dictionary<string, 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.
LeaderOptions List<string>
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
Name string
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
Project Changes to this property will trigger replacement. string
Replicas List<Pulumi.GoogleNative.Spanner.V1.Inputs.ReplicaInfo>
The geographic placement of nodes in this instance configuration and their replication properties.
ValidateOnly bool
An option to validate, but not actually execute, a request, and provide the same response.
InstanceConfigId This property is required. string
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
BaseConfig string
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.
DisplayName string
The name of this instance configuration as it appears in UIs.
Etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
Labels map[string]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.
LeaderOptions []string
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
Name string
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
Project Changes to this property will trigger replacement. string
Replicas []ReplicaInfoArgs
The geographic placement of nodes in this instance configuration and their replication properties.
ValidateOnly bool
An option to validate, but not actually execute, a request, and provide the same response.
instanceConfigId This property is required. String
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
baseConfig String
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.
displayName String
The name of this instance configuration as it appears in UIs.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
labels Map<String,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.
leaderOptions List<String>
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
name String
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
project Changes to this property will trigger replacement. String
replicas List<ReplicaInfo>
The geographic placement of nodes in this instance configuration and their replication properties.
validateOnly Boolean
An option to validate, but not actually execute, a request, and provide the same response.
instanceConfigId This property is required. string
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
baseConfig string
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.
displayName string
The name of this instance configuration as it appears in UIs.
etag string
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
labels {[key: string]: 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.
leaderOptions string[]
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
name string
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
project Changes to this property will trigger replacement. string
replicas ReplicaInfo[]
The geographic placement of nodes in this instance configuration and their replication properties.
validateOnly boolean
An option to validate, but not actually execute, a request, and provide the same response.
instance_config_id This property is required. str
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
base_config str
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.
display_name str
The name of this instance configuration as it appears in UIs.
etag str
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
labels Mapping[str, str]
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_options Sequence[str]
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
name str
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
project Changes to this property will trigger replacement. str
replicas Sequence[ReplicaInfoArgs]
The geographic placement of nodes in this instance configuration and their replication properties.
validate_only bool
An option to validate, but not actually execute, a request, and provide the same response.
instanceConfigId This property is required. String
The ID of the instance config to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google managed configurations.
baseConfig String
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.
displayName String
The name of this instance configuration as it appears in UIs.
etag String
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
labels Map<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.
leaderOptions List<String>
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
name String
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
project Changes to this property will trigger replacement. String
replicas List<Property Map>
The geographic placement of nodes in this instance configuration and their replication properties.
validateOnly Boolean
An option to validate, but not actually execute, a request, and provide the same response.

Outputs

All input properties are implicitly available as output properties. Additionally, the InstanceConfig resource produces the following output properties:

ConfigType string
Whether this instance config is a Google or User Managed Configuration.
FreeInstanceAvailability string
Describes whether free instances are available to be created in this instance config.
Id string
The provider-assigned unique ID for this managed resource.
OptionalReplicas List<Pulumi.GoogleNative.Spanner.V1.Outputs.ReplicaInfoResponse>
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
Reconciling bool
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
State string
The current instance config state. Applicable only for USER_MANAGED configs.
ConfigType string
Whether this instance config is a Google or User Managed Configuration.
FreeInstanceAvailability string
Describes whether free instances are available to be created in this instance config.
Id string
The provider-assigned unique ID for this managed resource.
OptionalReplicas []ReplicaInfoResponse
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
Reconciling bool
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
State string
The current instance config state. Applicable only for USER_MANAGED configs.
configType String
Whether this instance config is a Google or User Managed Configuration.
freeInstanceAvailability String
Describes whether free instances are available to be created in this instance config.
id String
The provider-assigned unique ID for this managed resource.
optionalReplicas List<ReplicaInfoResponse>
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
reconciling Boolean
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
state String
The current instance config state. Applicable only for USER_MANAGED configs.
configType string
Whether this instance config is a Google or User Managed Configuration.
freeInstanceAvailability string
Describes whether free instances are available to be created in this instance config.
id string
The provider-assigned unique ID for this managed resource.
optionalReplicas ReplicaInfoResponse[]
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
reconciling boolean
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
state string
The current instance config state. Applicable only for USER_MANAGED configs.
config_type str
Whether this instance config is a Google or User Managed Configuration.
free_instance_availability str
Describes whether free instances are available to be created in this instance config.
id str
The provider-assigned unique ID for this managed resource.
optional_replicas Sequence[ReplicaInfoResponse]
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
reconciling bool
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
state str
The current instance config state. Applicable only for USER_MANAGED configs.
configType String
Whether this instance config is a Google or User Managed Configuration.
freeInstanceAvailability String
Describes whether free instances are available to be created in this instance config.
id String
The provider-assigned unique ID for this managed resource.
optionalReplicas List<Property Map>
The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
reconciling Boolean
If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
state String
The current instance config state. Applicable only for USER_MANAGED configs.

Supporting Types

ReplicaInfo
, ReplicaInfoArgs

DefaultLeaderLocation bool
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 string
The location of the serving resources, e.g. "us-central1".
Type Pulumi.GoogleNative.Spanner.V1.ReplicaInfoType
The type of replica.
DefaultLeaderLocation bool
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 string
The location of the serving resources, e.g. "us-central1".
Type ReplicaInfoType
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.
location String
The location of the serving resources, e.g. "us-central1".
type ReplicaInfoType
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.
location string
The location of the serving resources, e.g. "us-central1".
type ReplicaInfoType
The type of replica.
default_leader_location bool
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 str
The location of the serving resources, e.g. "us-central1".
type ReplicaInfoType
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.
location String
The location of the serving resources, e.g. "us-central1".
type "TYPE_UNSPECIFIED" | "READ_WRITE" | "READ_ONLY" | "WITNESS"
The type of replica.

ReplicaInfoResponse
, ReplicaInfoResponseArgs

DefaultLeaderLocation This property is required. bool
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 This property is required. string
The location of the serving resources, e.g. "us-central1".
Type This property is required. string
The type of replica.
DefaultLeaderLocation This property is required. bool
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 This property is required. string
The location of the serving resources, e.g. "us-central1".
Type This property is required. string
The type of replica.
defaultLeaderLocation This property is required. 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.
location This property is required. String
The location of the serving resources, e.g. "us-central1".
type This property is required. String
The type of replica.
defaultLeaderLocation This property is required. 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.
location This property is required. string
The location of the serving resources, e.g. "us-central1".
type This property is required. string
The type of replica.
default_leader_location This property is required. bool
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 This property is required. str
The location of the serving resources, e.g. "us-central1".
type This property is required. str
The type of replica.
defaultLeaderLocation This property is required. 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.
location This property is required. String
The location of the serving resources, e.g. "us-central1".
type This property is required. String
The type of replica.

ReplicaInfoType
, ReplicaInfoTypeArgs

TypeUnspecified
TYPE_UNSPECIFIEDNot specified.
ReadWrite
READ_WRITERead-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.
ReadOnly
READ_ONLYRead-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
WITNESSWitness 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.
ReplicaInfoTypeTypeUnspecified
TYPE_UNSPECIFIEDNot specified.
ReplicaInfoTypeReadWrite
READ_WRITERead-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.
ReplicaInfoTypeReadOnly
READ_ONLYRead-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.
ReplicaInfoTypeWitness
WITNESSWitness 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.
TypeUnspecified
TYPE_UNSPECIFIEDNot specified.
ReadWrite
READ_WRITERead-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.
ReadOnly
READ_ONLYRead-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
WITNESSWitness 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.
TypeUnspecified
TYPE_UNSPECIFIEDNot specified.
ReadWrite
READ_WRITERead-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.
ReadOnly
READ_ONLYRead-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
WITNESSWitness 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.
TYPE_UNSPECIFIED
TYPE_UNSPECIFIEDNot specified.
READ_WRITE
READ_WRITERead-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_ONLYRead-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
WITNESSWitness 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.
"TYPE_UNSPECIFIED"
TYPE_UNSPECIFIEDNot specified.
"READ_WRITE"
READ_WRITERead-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_ONLYRead-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"
WITNESSWitness 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.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native