.TH "GCLOUD_BETA_SPANNER_BACKUP\-SCHEDULES_UPDATE" 1



.SH "NAME"
.HP
gcloud beta spanner backup\-schedules update \- update a Cloud Spanner backup schedule



.SH "SYNOPSIS"
.HP
\f5gcloud beta spanner backup\-schedules update\fR (\fIBACKUP_SCHEDULE\fR\ :\ \fB\-\-database\fR=\fIDATABASE\fR\ \fB\-\-instance\fR=\fIINSTANCE\fR) (\fB\-\-cron\fR=\fICRON\fR\ \fB\-\-encryption\-type\fR=\fIENCRYPTION_TYPE\fR\ \fB\-\-retention\-duration\fR=\fIRETENTION_DURATION\fR\ \fB\-\-kms\-keys\fR=[\fIKMS_KEYS\fR,...]\ |\ [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR]) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update a Cloud Spanner backup schedule.



.SH "EXAMPLES"

To update a Cloud Spanner backup schedule, run:

.RS 2m
$ gcloud beta spanner backup\-schedules update backup\-schedule\-id \e
    \-\-instance=instance\-id \-\-database=database\-id \e
    \-\-cron="0 2 * * *" \-\-retention\-duration=2w \e
    \-\-encryption\-type=GOOGLE_DEFAULT_ENCRYPTION
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup schedule resource \- The Cloud Spanner backup schedule to create. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5backup_schedule\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIBACKUP_SCHEDULE\fR

ID of the backup\-schedule or fully qualified identifier for the
backup\-schedule.

To set the \f5backup\-schedule\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_schedule\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

The Cloud Spanner database for the backup\-schedule.

To set the \f5database\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_schedule\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-database\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

The Cloud Spanner instance for the backup\-schedule.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_schedule\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line;
.IP "\(bu" 2m
set the property \f5spanner/instance\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-cron\fR=\fICRON\fR

Textual representation of the crontab. User can customize the backup frequency
and the backup version time using the cron expression. The version time must be
in UTC timzeone. The backup will contain an externally consistent copy of the
database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and
1 month. Examples of valid cron specifications: * \f50 2/12 * * * \fR : every 12
hours at (2, 14) hours past midnight in UTC. * \f50 2,14 * * * \fR : every 12
hours at (2,14) hours past midnight in UTC. * \f50 2 * * * \fR : once a day at 2
past midnight in UTC. * \f50 2 * * 0 \fR : once a week every Sunday at 2 past
midnight in UTC. * \f50 2 8 * * \fR : once a month on 8th day at 2 past midnight
in UTC.

.TP 2m
\fB\-\-encryption\-type\fR=\fIENCRYPTION_TYPE\fR

The encryption type of the backup. \fIENCRYPTION_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBcustomer\-managed\-encryption\fR
Use the provided Cloud KMS key for encryption. If this option is selected,
kms\-key must be set.
.TP 2m
\fBgoogle\-default\-encryption\fR
Use Google default encryption.
.TP 2m
\fBuse\-database\-encryption\fR
Use the same encryption configuration as the database.
.RE
.sp


.TP 2m
\fB\-\-retention\-duration\fR=\fIRETENTION_DURATION\fR

The retention duration of a backup that must be at least 6 hours and at most 366
days. The backup is eligible to be automatically deleted once the retention
period has elapsed.

.TP 2m

KMS key name group

At most one of these can be specified:


.RS 2m
.TP 2m

Key resource \- Cloud KMS key(s) to be used to create 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 \f5kms\-project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keys\fR on the command line with a fully
specified name.
.RE
.sp

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keys\fR on the command line with a fully
specified name.
.RE
.sp

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keys\fR on the command line with a fully
specified name.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-kms\-keys\fR=[\fIKMS_KEYS\fR,...]

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

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-keys\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m

Key resource \- Cloud KMS key to be used to create the Cloud Spanner backup. The
arguments in this group can be used to specify the attributes of this resource.


.RS 2m
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

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

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

KMS keyring id of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

Cloud project id for the key.

To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-project\fR on the command line.
.RE
.sp


.RE
.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud spanner backup\-schedules update
.RE

.RS 2m
$ gcloud alpha spanner backup\-schedules update
.RE