InstanceConfigArgs class

The set of arguments for InstanceConfig. The set of arguments for InstanceConfig.

Constructors

InstanceConfigArgs({Input<String>? baseConfig, Input<String>? displayName, Input<String>? etag, required Input<String> instanceConfigId, Input<Map<String, String>>? labels, Input<List<String>>? leaderOptions, Input<String>? name, Input<String>? project, Input<List<ReplicaInfo>>? replicas, Input<bool>? validateOnly})
Creates a new InstanceConfigArgs. baseConfig 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 The name of this instance configuration as it appears in UIs. etag 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. instanceConfigId 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. labels 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 Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. name A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*. project Optional. replicas The geographic placement of nodes in this instance configuration and their replication properties. validateOnly An option to validate, but not actually execute, a request, and provide the same response.
const
InstanceConfigArgs.fromMap(Map<String, dynamic> map)
factory

Properties

baseConfig → Input<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.
final
displayName → Input<String>?
The name of this instance configuration as it appears in UIs.
final
etag → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceConfigId → Input<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.
final
labels → Input<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.
final
leaderOptions → Input<List<String>>?
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
final
name → Input<String>?
A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
final
project → Input<String>?
final
replicas → Input<List<ReplicaInfo>>?
The geographic placement of nodes in this instance configuration and their replication properties.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validateOnly → Input<bool>?
An option to validate, but not actually execute, a request, and provide the same response.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited