Backup Plan

Docs > DDSQL Reference > Data Directory > Backup Plan

A Backup Plan in Google Cloud is a configuration that defines how backups are created, scheduled, and retained for resources such as persistent disks or file systems. It specifies policies for backup frequency, retention duration, and lifecycle management, ensuring data protection and recovery options in case of failures or data loss.

gcp.gkebackup_backup_plan

Fields

ID	Type	Data Type	Description
_key	core	string
ancestors	core	array<string>
backup_config	core	json	Optional. Defines the configuration of Backups created via this BackupPlan.
backup_schedule	core	json	Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
cluster	core	string	Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects//locations//clusters/` - `projects//zones//clusters/`
create_time	core	timestamp	Output only. The timestamp when this BackupPlan resource was created.
datadog_display_name	core	string
deactivated	core	bool	Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
description	core	string	Optional. User specified descriptive string for this BackupPlan.
etag	core	string	Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource.
labels	core	array<string>	Optional. A set of custom labels supplied by user.
last_successful_backup_time	core	timestamp	Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.
name	core	string	Output only. The full name of the BackupPlan resource. Format: `projects//locations//backupPlans/*`
organization_id	core	string
parent	core	string
project_id	core	string
project_number	core	string
protected_pod_count	core	int64	Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
resource_name	core	string
retention_policy	core	json	Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
rpo_risk_level	core	int64	Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
rpo_risk_reason	core	string	Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
state	core	string	Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
state_reason	core	string	Output only. Human-readable description of why BackupPlan 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.
tags	core	hstore
uid	core	string	Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
update_time	core	timestamp	Output only. The timestamp when this BackupPlan resource was last updated.