- NAME
-
- gcloud alpha backup-dr backups update - update the specified Backup
- SYNOPSIS
-
-
gcloud alpha backup-dr backups update(BACKUP:--backup-vault=BACKUP_VAULT--data-source=DATA_SOURCE--location=LOCATION) (--enforced-retention-end-time=ENFORCED_RETENTION_END_TIME--expire-time=EXPIRE_TIME) [--async] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Update the specified Backup. - EXAMPLES
-
To update the enforced retention of a backup sample-backup in backup vault
sample-vault, data source sample-ds, project sample-project and location
us-central1, run:
gcloud alpha backup-dr backups update sample-backup --backup-vault=sample-vault --data-source=sample-ds --project=sample-project --location=us-central1 --enforced-retention-end-time="2025-02-14T01:10:20Z" - POSITIONAL ARGUMENTS
-
-
Backup resource - Name of the backup to update. The arguments 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 in other ways.
To set the
projectattribute:-
provide the argument
backupon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
BACKUP-
ID of the Backup or fully qualified identifier for the Backup.
To set the
nameattribute:-
provide the argument
backupon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--backup-vault=BACKUP_VAULT-
The ID of the Backup Vault.
To set the
backup-vaultattribute:-
provide the argument
backupon the command line with a fully specified name; -
provide the argument
--backup-vaulton the command line.
-
provide the argument
--data-source=DATA_SOURCE-
The ID of the Data Source.
To set the
data-sourceattribute:-
provide the argument
backupon the command line with a fully specified name; -
provide the argument
--data-sourceon the command line.
-
provide the argument
--location=LOCATION-
The location of the Backup.
To set the
locationattribute:-
provide the argument
backupon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Backup resource - Name of the backup to update. The arguments 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 in other ways.
- REQUIRED FLAGS
-
-
Update Backup Flags
At least one of these must be specified:
--enforced-retention-end-time=ENFORCED_RETENTION_END_TIME-
Backups cannot be deleted until this time or later. This period can be extended,
but not shortened. It should be specified in the format of "YYYY-MM-DD".
- For backup configured with a backup appliance, there are additional restrictions: 1. Enforced retention cannot be extended past the expiry time. 2. Enforced retention can only be updated for finalized backups.
--expire-time=EXPIRE_TIME- The date when this backup is automatically expired. This date can be extended, but not shortened. It should be specified in the format of "YYYY-MM-DD".
-
Update Backup Flags
- OPTIONAL FLAGS
-
--async-
Return immediately, without waiting for the operation in progress to complete.
The default is
True. Enabled by default, use--no-asyncto disable.
- 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 helpfor details. - BRIEF
- Updates a specific backup
- NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud backup-dr backups update
gcloud alpha backup-dr backups update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-05 UTC.