AlloyDB Backup

AlloyDB Backup in Google Cloud is a managed backup resource for AlloyDB databases. It allows you to create consistent, point-in-time copies of your AlloyDB clusters, which can be used for data recovery or cloning environments. Backups are stored securely and can be restored to new or existing clusters, helping protect against data loss and enabling reliable disaster recovery.

gcp.alloydb_backup

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
cluster_namecorestringRequired. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
cluster_uidcorestringOutput only. The system-generated UID of the cluster which was used to create this resource.
create_timecoretimestampOutput only. Create time stamp
database_versioncorestringOutput only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
datadog_display_namecorestring
delete_timecoretimestampOutput only. Delete time stamp
descriptioncorestringUser-provided description of the backup.
encryption_configcorejsonOptional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
encryption_infocorejsonOutput only. The encryption information for the backup.
etagcorestringFor Resource freshness validation (https://google.aip.dev/154)
expiry_quantitycorejsonOutput only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
expiry_timecoretimestampOutput only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
gcp_display_namecorestringUser-settable and human-readable display name for the Backup.
labelscorearray<string>Labels as key value pairs
namecorestringOutput only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup 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 backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
reconcilingcoreboolOutput only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
resource_namecorestring
satisfies_pzscoreboolOutput only. Reserved for future use.
size_bytescoreint64Output only. The size of the backup in bytes.
statecorestringOutput only. The current state of the backup.
tagscorehstore
typecorestringThe backup type, which suggests the trigger for the backup.
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 Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.