gcloud bigtable backups update

NAME
gcloud bigtable backups update - update a backup, only supported for the following fields: --expiration-date and --retention-period
SYNOPSIS
gcloud bigtable backups update(BACKUP :--cluster=CLUSTER--instance=INSTANCE)[--hot-to-standard-time=HOT_TO_STANDARD_TIME][--expiration-date=EXPIRATION_DATE    |--retention-period=RETENTION_PERIOD][GCLOUD_WIDE_FLAG]
DESCRIPTION
Update a backup, only supported for the following fields: --expiration-date and--retention-period.
EXAMPLES
To update the expire time of backupBACKUP_NAME to 7 days from now,run:
gcloudbigtablebackupsupdateBACKUP_NAME--instance=INSTANCE_NAME--cluster=CLUSTER_NAME--retention-period=7d

To update the hot-to-standard time of backupBACKUP_NAME to2019-03-31T10:49:41Z, run:

gcloudbigtablebackupsupdateBACKUP_NAME--instance=INSTANCE_NAME--cluster=CLUSTER_NAME--hot-to-standard-time=2019-03-31T10:49:41Z

To update the hot-to-standard time of backupBACKUP_NAME to 7 daysfrom now, run:

gcloudbigtablebackupsupdateBACKUP_NAME--instance=INSTANCE_NAME--cluster=CLUSTER_NAME--hot-to-standard-time=+P7d

To clear the hot-to-standard time of backupBACKUP_NAME, run:

gcloudbigtablebackupsupdateBACKUP_NAME--instance=INSTANCE_NAME--cluster=CLUSTER_NAME--hot-to-standard-time=''
POSITIONAL ARGUMENTS
Backup resource - Cloud Bigtable backup to update. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other 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.

--cluster=CLUSTER
Name of the Bigtable cluster.

To set thecluster attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--cluster on the command line.
--instance=INSTANCE
Name of the Bigtable instance.

To set theinstance attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--instance on the command line.
FLAGS
--hot-to-standard-time=HOT_TO_STANDARD_TIME
Time at which a hot backup will be converted to a standard backup; must be atleast 24 hours from backup creation time. Only applies for hot backups. See$gcloud topicdatetimes for information on date/time formats. See$gcloud bigtable backupsdescribe for creation time.
At most one of these can be specified:
--expiration-date=EXPIRATION_DATE
Absolute expiration time of the backup; must be at least 6 hours and at most 90days from backup creation time. See$gcloud topic datetimesfor information on date/time formats. See$gcloud bigtable backupsdescribe for creation time.
--retention-period=RETENTION_PERIOD
Retention period of the backup relative from now; must be at least 6 hours andat most 90 days from backup creation time. See$gcloud topic datetimesfor information on duration formats. See$gcloud bigtable backupsdescribe for creation time.
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 thebigtableadmin/v2 API. The full documentationfor this API can be found at:https://cloud.google.com/bigtable/
NOTES
These variants are also available:
gcloudalphabigtablebackupsupdate
gcloudbetabigtablebackupsupdate

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-07-15 UTC.