Backup in Google Cloud is a managed service that allows you to create, manage, and restore backups of your data and workloads. It provides centralized backup management across multiple Google Cloud services, ensuring data protection, compliance, and disaster recovery. The service supports automated scheduling, retention policies, and secure storage of backup data.

gcp.gkebackup_backup

Fields

TitleIDTypeData TypeDescription
_keycorestring
all_namespacescoreboolOutput only. If True, all namespaces were included in the Backup.
ancestorscorearray<string>
cluster_metadatacorejsonOutput only. Information about the GKE cluster from which this Backup was created.
complete_timecoretimestampOutput only. Completion time of the Backup
config_backup_size_bytescoreint64Output only. The size of the config backup in bytes.
contains_secretscoreboolOutput only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
contains_volume_datacoreboolOutput only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
create_timecoretimestampOutput only. The timestamp when this Backup resource was created.
datadog_display_namecorestring
delete_lock_dayscoreint64Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).
delete_lock_expire_timecoretimestampOutput only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
descriptioncorestringOptional. User specified descriptive string for this Backup.
etagcorestringOutput only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.
labelscorearray<string>Optional. A set of custom labels supplied by user.
manualcoreboolOutput only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.
namecorestringOutput only. Identifier. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`
organization_idcorestring
parentcorestring
permissive_modecoreboolOutput only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.
pod_countcoreint64Output only. The total number of Kubernetes Pods contained in the Backup.
project_idcorestring
project_numbercorestring
region_idcorestring
resource_countcoreint64Output only. The total number of Kubernetes resources included in the Backup.
resource_namecorestring
retain_dayscoreint64Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
retain_expire_timecoretimestampOutput only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
satisfies_pzicoreboolOutput only. [Output Only] Reserved for future use.
satisfies_pzscoreboolOutput only. [Output Only] Reserved for future use.
selected_applicationscorejsonOutput only. If set, the list of ProtectedApplications whose resources were included in the Backup.
selected_namespacescorejsonOutput only. If set, the list of namespaces that were included in the Backup.
size_bytescoreint64Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
statecorestringOutput only. Current state of the Backup
state_reasoncorestringOutput only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
tagscorehstore_csv
uidcorestringOutput only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
update_timecoretimestampOutput only. The timestamp when this Backup resource was last updated.
volume_countcoreint64Output only. The total number of volume backups contained in the Backup.
zone_idcorestring