gcloud spanner backups copy

NAME

gcloud spanner backups copy - copies a backup of a Cloud Spanner database

SYNOPSIS

gcloud 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

Copies a backup of a Cloud Spanner database.

EXAMPLES

To copy a backup within the same project, run:

gcloud spanner backups copy --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:

gcloud spanner backups copy --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 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 project attribute:

• provide the argument --destination-backup on the command line with a fully specified name;
• provide the argument --project on the command line;
• set the property core/project.

This must be specified.

--destination-backup=DESTINATION_BACKUP

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

To set the backup attribute:

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

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

--destination-instance=DESTINATION_INSTANCE

The Cloud Spanner instance for the backup.

To set the instance attribute:

• provide the argument --destination-backup on the command line with a fully specified name;
• provide the argument --destination-instance on the command line;
• set the property spanner/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 days from the time when the source backup is created. See $ gcloud topic datetimes for information on date/time formats.

--retention-period=RETENTION_PERIOD

Retention period of the backup relative from now, must be at least 6 hours and at most 366 days from the time when the source backup is created. See $ gcloud topic datetimes for information on duration formats.

Backup resource - TEXT 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 project attribute:

• provide the argument --source-backup on the command line with a fully specified name;
• provide the argument --project on the command line;
• set the property core/project.

This must be specified.

--source-backup=SOURCE_BACKUP

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

To set the backup attribute:

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

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

--source-instance=SOURCE_INSTANCE

The Cloud Spanner instance for the backup.

To set the instance attribute:

• provide the argument --source-backup on the command line with a fully specified name;
• provide the argument --source-instance on the command line;
• set the property spanner/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 same encryption 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 arguments in this group but can be set in other ways.

To set the kms-project attribute:

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

To set the kms-location attribute:

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

To set the kms-keyring attribute:

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

--kms-keys=[KMS_KEYS,…]

IDs of the keys or fully qualified identifiers for the keys.

To set the kms-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. The arguments 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 the kms-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 group are specified.

--kms-keyring=KMS_KEYRING

KMS keyring id of the key.

To set the kms-keyring attribute:

• provide the argument --kms-key on the command line with a fully specified name;
• provide the argument --kms-keyring on the command line.

--kms-location=KMS_LOCATION

Cloud location for the key.

To set the kms-location attribute:

• provide the argument --kms-key on the command line with a fully specified name;
• provide the argument --kms-location on the command line.

--kms-project=KMS_PROJECT

Cloud project id for the key.

To set the kms-project attribute:

• provide the argument --kms-key on the command line with a fully specified 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

These variants are also available:

gcloud alpha spanner backups copy

gcloud beta spanner backups copy