AlloyDB Instance

AlloyDB Instance is a fully managed PostgreSQL-compatible database service on Google Cloud. It is designed for high performance, scalability, and availability, combining the familiarity of PostgreSQL with advanced cloud optimizations. This resource allows you to run transactional and analytical workloads efficiently, with automated backups, replication, and integrated security features.

gcp.alloydb_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
annotationscorehstoreAnnotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availability_typecorestringAvailability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
client_connection_configcorejsonOptional. Client connection specific configurations
create_timecoretimestampOutput only. Create time stamp
datadog_display_namecorestring
delete_timecoretimestampOutput only. Delete time stamp
etagcorestringFor Resource freshness validation (https://google.aip.dev/154)
gce_zonecorestringThe 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.
gcp_display_namecorestringUser-settable and human-readable display name for the Instance.
instance_typecorestringRequired. The type of the instance. Specified at creation time.
ip_addresscorestringOutput only. The IP address for the Instance. This is the connection endpoint for an end-user application.
labelscorearray<string>Labels as key value pairs
machine_configcorejsonConfigurations for the machines that host the underlying database engine.
namecorestringOutput only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
network_configcorejsonOptional. Instance-level network configuration.
nodescorejsonOutput only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
organization_idcorestring
outbound_public_ip_addressescorearray<string>Output only. All outbound public IP addresses configured for the instance.
parentcorestring
project_idcorestring
project_numbercorestring
psc_instance_configcorejsonOptional. The configuration for Private Service Connect (PSC) for the instance.
public_ip_addresscorestringOutput only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
query_insights_configcorejsonConfiguration for query insights.
read_pool_configcorejsonRead pool instance configuration. This is required if the value of instanceType is READ_POOL.
reconcilingcoreboolOutput only. Reconciling (https://google.aip.dev/128#reconciliation). 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.
resource_namecorestring
satisfies_pzscoreboolOutput only. Reserved for future use.
statecorestringOutput only. The current serving state of the instance.
tagscorehstore
uidcorestringOutput only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
update_timecoretimestampOutput only. Update time stamp
writable_nodecorejsonOutput only. This is set for the read-write VM of the PRIMARY instance only.