gcloud beta container backup-restore backups update

NAME
gcloud beta container backup-restore backups update - update a backup
SYNOPSIS
gcloud beta container backup-restore backups update(BACKUP :--backup-plan=BACKUP_PLAN--location=LOCATION)[--async][--delete-lock-days=DELETE_LOCK_DAYS][--description=DESCRIPTION][--etag=ETAG][--retain-days=RETAIN_DAYS][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Update a Backup for GKE backup.
EXAMPLES
To update a backupmy-backup in projectmy-project in locationus-central1 under backup planmy-backup-plan to add new description, run:
gcloudbetacontainerbackup-restorebackupsupdate'my-backup'--backup-plan=my-backup-plan--project=my-project--location=us-central1--description="New description"
POSITIONAL ARGUMENTS
Backup resource - Name of the backup to update. The name may be provided eitheras a relative name, e.g.projects/<project>/locations/<location>/backupPlans/<backupPlan>/backups/<backup>or as a single ID name (with the parent resources provided via options orthrough properties), e.g.BACKUP --project=<project>--location=<location> --backup-plan=<backupPlan>. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.

To set theproject attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

BACKUP
ID of the backup or fully qualified identifier for the backup.

To set thebackup attribute:

  • provide the argumentbackup on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--backup-plan=BACKUP_PLAN
Backup Plan name.

To set thebackup-plan attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--backup-plan on the command line;
  • set the propertygkebackup/backup_plan.
--location=LOCATION
Google Cloud location.

To set thelocation attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertygkebackup/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--delete-lock-days=DELETE_LOCK_DAYS
Delete lock days specifies the number of days from the createTime of this Backupbefore which deletion will be blocked. Must be >= the value in the backupplan. If not specified, inherited from the backup plan. Manual creation of abackup with this field unspecified causes the service to use the value ofbackupPlan.RetentionPolicy.backupDeleteBlockDays. Creation of a backup with thisfield set to a value SMALLER thanbackupPlan.RetentionPolicy.backupDeleteBlockDays results in an invalid responsefrom the service. This field MUST be an int value between 0-90(inclusive). Thisfield may only be INCREASED in an update command, or an invalid response will bereturned by the service.
--description=DESCRIPTION
Optional text description for the backup.
--etag=ETAG
The etag is used for optimistic concurrency control as a way to help preventsimultaneous updates or deletes of a resource from overwriting each other.
--retain-days=RETAIN_DAYS
Retain days specifies the desired number of days from the createTime of thisbackup after which it will be automatically deleted. If not specified or set to0, it means the backup will NOT be automatically deleted. Manual creation of abackup with this field unspecified causes the service to use the value ofbackupPlan.retentionPolicy.backupRetainDays. Creation of a backup with thisfield set to a value SMALLER than deleteLockDays results in an invalid responsefrom the service. This field may ONLY be increased in an Update command, or aninvalid response will be returned by the service immediately. Default to 0.
--update-labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of these can be specified:
--clear-labels
Remove all labels. If--update-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudbetacontainerbackup-restorebackupsupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudbetacontainerbackup-restorebackupsupdate--clear-labels--update-labelsfoo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is applied first.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses thegkebackup/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke
NOTES
This command is currently in beta and might change without notice. This variantis also available:
gcloudalphacontainerbackup-restorebackupsupdate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.