AlloyDB Cluster

AlloyDB Cluster in Google Cloud is a fully managed, high-performance database service compatible with PostgreSQL. It is designed for demanding enterprise workloads, offering scalability, strong consistency, and advanced analytics capabilities. The cluster manages compute and storage resources automatically, providing high availability, automated backups, and seamless integration with other Google Cloud services.

gcp.alloydb_cluster

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
automated_backup_policycorejsonThe automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
backup_sourcecorejsonOutput only. Cluster created from backup.
cluster_typecorestringOutput only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
continuous_backup_configcorejsonOptional. Continuous backup configuration for this cluster.
continuous_backup_infocorejsonOutput only. Continuous backup properties for this cluster.
create_timecoretimestampOutput only. Create time stamp
database_versioncorestringOptional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
datadog_display_namecorestring
delete_timecoretimestampOutput only. Delete time stamp
encryption_configcorejsonOptional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
encryption_infocorejsonOutput only. The encryption information for the cluster.
etagcorestringFor Resource freshness validation (https://google.aip.dev/154)
gcp_display_namecorestringUser-settable and human-readable display name for the Cluster.
initial_usercorejsonInput only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
labelscorearray<string>Labels as key value pairs
maintenance_schedulecorejsonOutput only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
maintenance_update_policycorejsonOptional. The maintenance update policy determines when to allow or deny updates.
migration_sourcecorejsonOutput only. Cluster created via DMS migration.
namecorestringOutput only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
networkcorestringRequired. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead.
network_configcorejson
organization_idcorestring
parentcorestring
primary_configcorejsonOutput only. Cross Region replication config specific to PRIMARY cluster.
project_idcorestring
project_numbercorestring
psc_configcorejsonOptional. The configuration for Private Service Connect (PSC) for the cluster.
reconcilingcoreboolOutput only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster 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.
secondary_configcorejsonCross Region replication config specific to SECONDARY cluster.
ssl_configcorejsonSSL configuration for this AlloyDB cluster.
statecorestringOutput only. The current serving state of the cluster.
subscription_typecorestringOptional. Subscription type of the cluster.
tagscorehstore
trial_metadatacorejsonOutput only. Metadata for free trial clusters
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