gcloud alpha spanner backups copy

NAME
gcloud alpha spanner backups copy - copies a backup of a Cloud Spanner database
SYNOPSIS
gcloud alpha spanner backups copy(--destination-backup=DESTINATION_BACKUP :--destination-instance=DESTINATION_INSTANCE)(--expiration-date=EXPIRATION_DATE    |--retention-period=RETENTION_PERIOD)(--source-backup=SOURCE_BACKUP :--source-instance=SOURCE_INSTANCE)[--async][--encryption-type=ENCRYPTION_TYPE--kms-keys=[KMS_KEYS,…]    | [--kms-key=KMS_KEY :--kms-keyring=KMS_KEYRING--kms-location=KMS_LOCATION--kms-project=KMS_PROJECT]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Copies a backup of a Cloud Spanner database.
EXAMPLES
To copy a backup within the same project, run:
gcloudalphaspannerbackupscopy--source-instance=SOURCE_INSTANCE_ID--source-backup=SOURCE_BACKUP_ID--destination-instance=DESTINATION_INSTANCE_ID--destination-backup=DESTINATION_BACKUP_ID--expiration-date=2020-03-29T10:49:41Z

To copy a backup to a different project, run:

gcloudalphaspannerbackupscopy--source-backup=projects/SOURCE_PROJECT_ID/instances/SOURCE_INSTANCE_ID/backups/SOURCE_BACKUP_ID--destination-backup=projects/DESTINATION_PROJECT_ID/instances/DESTINATION_INSTANCE_ID/backups/DESTINATION_BACKUP_ID--expiration-date=2020-03-29T10:49:41Z
REQUIRED FLAGS
Backup resource - TEXT The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

  • provide the argument--destination-backup on the command line witha fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

--destination-backup=DESTINATION_BACKUP
ID of the backup or fully qualified identifier for the backup.

To set thebackup attribute:

  • provide the argument--destination-backup on the command line.

This flag argument must be specified if any of the other arguments in this groupare specified.

--destination-instance=DESTINATION_INSTANCE
The Cloud Spanner instance for the backup.

To set theinstance attribute:

  • provide the argument--destination-backup on the command line witha fully specified name;
  • provide the argument--destination-instance on the command line;
  • set the propertyspanner/instance.
Exactly one of these must be specified:
--expiration-date=EXPIRATION_DATE
Expiration time of the backup, must be at least 6 hours and at most 366 daysfrom the time when the source backup is created. See$gcloud topic datetimesfor information on date/time formats.
--retention-period=RETENTION_PERIOD
Retention period of the backup relative from now, must be at least 6 hours andat most 366 days from the time when the source backup is created. See$gcloud topic datetimesfor information on duration formats.
Backup resource - TEXT The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

  • provide the argument--source-backup on the command line with afully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

--source-backup=SOURCE_BACKUP
ID of the backup or fully qualified identifier for the backup.

To set thebackup attribute:

  • provide the argument--source-backup on the command line.

This flag argument must be specified if any of the other arguments in this groupare specified.

--source-instance=SOURCE_INSTANCE
The Cloud Spanner instance for the backup.

To set theinstance attribute:

  • provide the argument--source-backup on the command line with afully specified name;
  • provide the argument--source-instance on the command line;
  • set the propertyspanner/instance.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--encryption-type=ENCRYPTION_TYPE
The encryption type of the copied backup.ENCRYPTION_TYPE must be one of:
customer-managed-encryption
Use the provided Cloud KMS key for encryption. If this option is selected,kms-key must be set.
google-default-encryption
Use Google default encryption.
use-config-default-or-backup-encryption
Use the default encryption configuration if one exists. otherwise use the sameencryption configuration as the source backup.
KMS key name group

At most one of these can be specified:

Key resource - Cloud KMS key(s) to be used to copy the Cloud Spanner backup.This represents a Cloud resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.

To set thekms-project attribute:

  • provide the argument--kms-keys on the command line with a fullyspecified name.

To set thekms-location attribute:

  • provide the argument--kms-keys on the command line with a fullyspecified name.

To set thekms-keyring attribute:

  • provide the argument--kms-keys on the command line with a fullyspecified name.
--kms-keys=[KMS_KEYS,…]
IDs of the keys or fully qualified identifiers for the keys.

To set thekms-key attribute:

  • provide the argument--kms-keys on the command line.
Key resource - Cloud KMS key to be used to copy the Cloud Spanner backup. Thearguments in this group can be used to specify the attributes of this resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.

To set thekms-key attribute:

  • provide the argument--kms-key on the command line.

This flag argument must be specified if any of the other arguments in this groupare specified.

--kms-keyring=KMS_KEYRING
KMS keyring id of the key.

To set thekms-keyring attribute:

  • provide the argument--kms-key on the command line with a fullyspecified name;
  • provide the argument--kms-keyring on the command line.
--kms-location=KMS_LOCATION
Cloud location for the key.

To set thekms-location attribute:

  • provide the argument--kms-key on the command line with a fullyspecified name;
  • provide the argument--kms-location on the command line.
--kms-project=KMS_PROJECT
Cloud project id for the key.

To set thekms-project attribute:

  • provide the argument--kms-key on the command line with a fullyspecified name;
  • provide the argument--kms-project on the command line.
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.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudspannerbackupscopy
gcloudbetaspannerbackupscopy

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 2026-02-18 UTC.