Backup Vault

A Backup Vault in Google Cloud is a managed container that securely stores backup data for various GCP services. It centralizes backup management, enabling consistent policies, retention settings, and access controls. The vault ensures data durability, encryption, and compliance with organizational or regulatory requirements.

gcp.backupdr_backup_vault

Fields

TitleIDTypeData TypeDescription
_keycorestring
access_restrictioncorestringOptional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
ancestorscorearray<string>
annotationscorehstoreOptional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
backup_countcoreint64Output only. The number of backups in this backup vault.
backup_minimum_enforced_retention_durationcorestringRequired. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
create_timecoretimestampOutput only. The time when the instance was created.
datadog_display_namecorestring
deletablecoreboolOutput only. Set to true when there are no backups nested under this resource.
descriptioncorestringOptional. The description of the BackupVault instance (2048 characters or less).
effective_timecoretimestampOptional. Time after which the BackupVault resource is locked.
etagcorestringOptional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
labelscorearray<string>Optional. Resource labels to represent user provided metadata. No labels currently defined:
namecorestringOutput only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
region_idcorestring
resource_namecorestring
service_accountcorestringOutput only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
statecorestringOutput only. The BackupVault resource instance state.
tagscorehstore_csv
total_stored_bytescoreint64Output only. Total size of the storage used by all backup resources.
uidcorestringOutput only. Immutable after resource creation until resource deletion.
update_timecoretimestampOutput only. The time when the instance was updated.
zone_idcorestring