InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<String?>? activationPolicy, Input<Map<String, String>?>? annotations, Input<String?>? availabilityType, Input<InstanceClientConnectionConfig?>? clientConnectionConfig, Input<String?>? cluster, Input<InstanceConnectionPoolConfig?>? connectionPoolConfig, Input<String?>? createTime, Input<Map<String, String>?>? databaseFlags, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<Map<String, String>?>? effectiveAnnotations, Input<Map<String, String>?>? effectiveLabels, Input<String?>? gceZone, Input<String?>? instanceId, Input<String?>? instanceType, Input<String?>? ipAddress, Input<Map<String, String>?>? labels, Input<InstanceMachineConfig?>? machineConfig, Input<String?>? name, Input<InstanceNetworkConfig?>? networkConfig, Input<InstanceObservabilityConfig?>? observabilityConfig, Input<List<String>?>? outboundPublicIpAddresses, Input<InstancePscInstanceConfig?>? pscInstanceConfig, Input<String?>? publicIpAddress, Input<Map<String, String>?>? pulumiLabels, Input<InstanceQueryInsightsConfig?>? queryInsightsConfig, Input<InstanceReadPoolConfig?>? readPoolConfig, Input<bool?>? reconciling, Input<String?>? state, Input<String?>? uid, Input<String?>? updateTime})
Creates a new InstanceState. activationPolicy 'Specifies whether an instance needs to spin up. Once the instance is annotations Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. availabilityType 'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. clientConnectionConfig Client connection specific configurations. cluster Identifies the alloydb cluster. Must be in the format connectionPoolConfig Configuration for Managed Connection Pool. createTime Time the Instance was created in UTC. databaseFlags Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName User-settable and human-readable display name for the Instance. effectiveAnnotations All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. gceZone The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. instanceId The ID of the alloydb instance. instanceType The type of the instance. ipAddress The IP address for the Instance. This is the connection endpoint for an end-user application. labels User-defined labels for the alloydb instance. machineConfig Configurations for the machines that host the underlying database engine. name The name of the instance resource. networkConfig Instance level network configuration. observabilityConfig (Optional, Beta) outboundPublicIpAddresses The outbound public IP addresses for the instance. This is available ONLY when pscInstanceConfig Configuration for Private Service Connect (PSC) for the instance. publicIpAddress The public IP addresses for the Instance. This is available ONLY when pulumiLabels The combination of labels configured directly on the resource queryInsightsConfig Configuration for query insights. readPoolConfig Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. reconciling Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. state The current state of the alloydb instance. uid The system-generated UID of the resource. updateTime Time the Instance was updated in UTC.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

activationPolicy → Input<String?>?
'Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the NEVER to stop the instance. Likewise, the activation policy can be updated to ALWAYS to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details. Possible values are: ACTIVATION_POLICY_UNSPECIFIED, ALWAYS, NEVER.' Possible values are: ACTIVATION_POLICY_UNSPECIFIED, ALWAYS, NEVER.
final
annotations → Input<Map<String, String>?>?
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.
final
availabilityType → Input<String?>?
'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Primary instances can be either ZONAL or REGIONAL. Read Pool instances can also be either ZONAL or REGIONAL. Read pools of size 1 can only have zonal availability. Read pools with a node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region). Possible values are: AVAILABILITY_TYPE_UNSPECIFIED, ZONAL, REGIONAL.' Possible values are: AVAILABILITY_TYPE_UNSPECIFIED, ZONAL, REGIONAL.
final
clientConnectionConfig → Input<InstanceClientConnectionConfig?>?
Client connection specific configurations. Structure is documented below.
final
cluster → Input<String?>?
Identifies the alloydb cluster. Must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'
final
connectionPoolConfig → Input<InstanceConnectionPoolConfig?>?
Configuration for Managed Connection Pool. Structure is documented below.
final
createTime → Input<String?>?
Time the Instance was created in UTC.
final
databaseFlags → Input<Map<String, String>?>?
Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.
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?>?
User-settable and human-readable display name for the Instance.
final
effectiveAnnotations → Input<Map<String, String>?>?
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
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
gceZone → Input<String?>?
The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceId → Input<String?>?
The ID of the alloydb instance.
final
instanceType → Input<String?>?
The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY/SECONDARY instance in the dependsOn meta-data attribute. If the instance type is SECONDARY, point to the clusterType of the associated secondary cluster instead of mentioning SECONDARY. Example: {instance_type = google_alloydb_cluster.<secondary_cluster_name>.cluster_type} instead of {instance_type = SECONDARY} If the instance type is SECONDARY, the terraform delete instance operation does not delete the secondary instance but abandons it instead. Use deletionPolicy = "FORCE" in the associated secondary cluster and delete the cluster forcefully to delete the secondary cluster as well its associated secondary instance. Users can undo the delete secondary instance action by importing the deleted secondary instance by calling terraform import. Possible values are: PRIMARY, READ_POOL, SECONDARY.
final
ipAddress → Input<String?>?
The IP address for the Instance. This is the connection endpoint for an end-user application.
final
labels → Input<Map<String, String>?>?
User-defined labels for the alloydb instance. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
machineConfig → Input<InstanceMachineConfig?>?
Configurations for the machines that host the underlying database engine. Structure is documented below.
final
name → Input<String?>?
The name of the instance resource.
final
networkConfig → Input<InstanceNetworkConfig?>?
Instance level network configuration. Structure is documented below.
final
observabilityConfig → Input<InstanceObservabilityConfig?>?
(Optional, Beta) Configuration for enhanced query insights. Structure is documented below.
final
outboundPublicIpAddresses → Input<List<String>?>?
The outbound public IP addresses for the instance. This is available ONLY when networkConfig.enableOutboundPublicIp is set to true. These IP addresses are used for outbound connections.
final
pscInstanceConfig → Input<InstancePscInstanceConfig?>?
Configuration for Private Service Connect (PSC) for the instance. Structure is documented below.
final
publicIpAddress → Input<String?>?
The public IP addresses for the Instance. This is available ONLY when networkConfig.enablePublicIp is set to true. This is the connection endpoint for an end-user application.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
queryInsightsConfig → Input<InstanceQueryInsightsConfig?>?
Configuration for query insights. Structure is documented below.
final
readPoolConfig → Input<InstanceReadPoolConfig?>?
Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. Structure is documented below.
final
reconciling → Input<bool?>?
Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
The current state of the alloydb instance.
final
uid → Input<String?>?
The system-generated UID of the resource.
final
updateTime → Input<String?>?
Time the Instance was updated in UTC.
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