InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<InstanceAutoscalingConfig?>? autoscalingConfig, Input<String?>? config, Input<String?>? defaultBackupScheduleType, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<String?>? edition, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? forceDestroy, Input<String?>? instanceType, Input<Map<String, String>?>? labels, Input<String?>? name, Input<int?>? numNodes, Input<int?>? processingUnits, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? state})
Creates a new InstanceState. autoscalingConfig The autoscaling configuration. Autoscaling is enabled if this field is set. config The name of the instance's configuration (similar but not defaultBackupScheduleType Controls the default backup behavior for new databases within the instance. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName The descriptive name for this instance as it appears in UIs. Must be edition The edition selected for this instance. Different editions provide different capabilities at different price points. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. forceDestroy When deleting a spanner instance, this boolean option will delete all backups of this instance. instanceType The type of this instance. The type can be used to distinguish product variants, that can affect aspects like: labels An object containing a list of "key": value pairs. name A unique identifier for the instance, which cannot be changed after numNodes The number of nodes allocated to this instance. Exactly one of either num_nodes, processingUnits or processingUnits The number of processing units allocated to this instance. Exactly one of either num_nodes, project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource state Instance status: CREATING or READY.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

autoscalingConfig → Input<InstanceAutoscalingConfig?>?
The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either num_nodes, processingUnits or autoscalingConfig must be present in terraform except when instanceType = FREE_INSTANCE. When autoscaling is enabled, numNodes and processingUnits are treated as, OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. Structure is documented below.
final
config → Input<String?>?
The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance. It determines where your data is stored. Values are typically of the form regional-europe-west1 , us-central etc. In order to obtain a valid list please consult the Configuration section of the docs.
final
defaultBackupScheduleType → Input<String?>?
Controls the default backup behavior for new databases within the instance. Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances. if unset or NONE, no default backup schedule will be created for new databases within the instance. Possible values are: NONE, AUTOMATIC.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
displayName → Input<String?>?
The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
final
edition → Input<String?>?
The edition selected for this instance. Different editions provide different capabilities at different price points. Possible values are: EDITION_UNSPECIFIED, STANDARD, ENTERPRISE, ENTERPRISE_PLUS.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
forceDestroy → Input<bool?>?
When deleting a spanner instance, this boolean option will delete all backups of this instance. This must be set to true if you created a backup manually in the console.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceType → Input<String?>?
The type of this instance. The type can be used to distinguish product variants, that can affect aspects like: usage restrictions, quotas and billing. Currently this is used to distinguish FREE_INSTANCE vs PROVISIONED instances. When configured as FREE_INSTANCE, the field edition should not be configured. Possible values are: PROVISIONED, FREE_INSTANCE.
final
labels → Input<Map<String, String>?>?
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
name → Input<String?>?
A unique identifier for the instance, which cannot be changed after the instance is created. The name must be between 6 and 30 characters in length. If not provided, a random string starting with tf- will be selected.
final
numNodes → Input<int?>?
The number of nodes allocated to this instance. Exactly one of either num_nodes, processingUnits or autoscalingConfig must be present in terraform except when instanceType = FREE_INSTANCE.
final
processingUnits → Input<int?>?
The number of processing units allocated to this instance. Exactly one of either num_nodes, processingUnits or autoscalingConfig must be present in terraform except when instanceType = FREE_INSTANCE.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
Instance status: CREATING or READY.
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