File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_alloydb_clusters_update.1
.TH "GCLOUD_ALPHA_ALLOYDB_CLUSTERS_UPDATE" 1
.SH "NAME"
.HP
gcloud alpha alloydb clusters update \- update an AlloyDB cluster within a given project and region
.SH "SYNOPSIS"
.HP
\f5gcloud alpha alloydb clusters update\fR \fICLUSTER\fR \fB\-\-region\fR=\fIREGION\fR [\fB\-\-async\fR] [\fB\-\-subscription\-type\fR=\fISUBSCRIPTION_TYPE\fR] [\fB\-\-clear\-automated\-backup\fR\ |\ \fB\-\-disable\-automated\-backup\fR\ |\ \fB\-\-automated\-backup\-days\-of\-week\fR=[\fIDAYS_OF_WEEK\fR,...]\ \fB\-\-automated\-backup\-start\-times\fR=[\fISTART_TIMES\fR,...]\ \fB\-\-automated\-backup\-window\fR=\fITIMEOUT_PERIOD\fR\ [\fB\-\-automated\-backup\-encryption\-key\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY\fR\ :\ \fB\-\-automated\-backup\-encryption\-key\-keyring\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING\fR\ \fB\-\-automated\-backup\-encryption\-key\-location\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION\fR\ \fB\-\-automated\-backup\-encryption\-key\-project\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT\fR]\ \fB\-\-automated\-backup\-retention\-count\fR=\fIRETENTION_COUNT\fR\ |\ \fB\-\-automated\-backup\-retention\-period\fR=\fIRETENTION_PERIOD\fR] [\fB\-\-continuous\-backup\-recovery\-window\-days\fR=\fIRECOVERY_PERIOD\fR\ \fB\-\-enable\-continuous\-backup\fR\ \fB\-\-clear\-continuous\-backup\-encryption\-key\fR\ |\ [\fB\-\-continuous\-backup\-encryption\-key\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY\fR\ :\ \fB\-\-continuous\-backup\-encryption\-key\-keyring\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING\fR\ \fB\-\-continuous\-backup\-encryption\-key\-location\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION\fR\ \fB\-\-continuous\-backup\-encryption\-key\-project\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT\fR]] [\fB\-\-maintenance\-window\-any\fR\ |\ \fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR\ \fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR] [\fB\-\-remove\-deny\-maintenance\-period\fR\ |\ \fB\-\-deny\-maintenance\-period\-end\-date\fR=\fIDENY_MAINTENANCE_PERIOD_END_DATE\fR\ \fB\-\-deny\-maintenance\-period\-start\-date\fR=\fIDENY_MAINTENANCE_PERIOD_START_DATE\fR\ \fB\-\-deny\-maintenance\-period\-time\fR=\fIDENY_MAINTENANCE_PERIOD_TIME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Update an AlloyDB cluster within a given project and region.
.SH "EXAMPLES"
To update a cluster, run:
.RS 2m
$ gcloud alpha alloydb clusters update my\-cluster \e
\-\-region=us\-central1 \-\-automated\-backup\-start\-times=12:00 \e
\-\-automated\-backup\-days\-of\-week=MONDAY \e
\-\-automated\-backup\-retention\-count=10
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fICLUSTER\fR
AlloyDB cluster ID
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
Regional location (e.g. \f5asia\-east1\fR, \f5us\-east1\fR). See the full list
of regions at https://cloud.google.com/sql/docs/instance\-locations.
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-subscription\-type\fR=\fISUBSCRIPTION_TYPE\fR
Subscription type of the cluster. \fISUBSCRIPTION_TYPE\fR must be one of:
\fBSTANDARD\fR, \fBTRIAL\fR.
.TP 2m
Automated backup policy.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-automated\-backup\fR
Clears the automated backup policy on the cluster. The default automated backup
policy will be used.
.TP 2m
\fB\-\-disable\-automated\-backup\fR
Disables automated backups on the cluster.
.TP 2m
Enable automated backup policy.
.RS 2m
.TP 2m
\fB\-\-automated\-backup\-days\-of\-week\fR=[\fIDAYS_OF_WEEK\fR,...]
Comma\-separated list of days of the week to perform a backup. At least one day
of the week must be provided. (e.g.,
\-\-automated\-backup\-days\-of\-week=MONDAY,WEDNESDAY,SUNDAY).
\fIDAYS_OF_WEEK\fR must be one of: \fBMONDAY\fR, \fBTUESDAY\fR, \fBWEDNESDAY\fR,
\fBTHURSDAY\fR, \fBFRIDAY\fR, \fBSATURDAY\fR, \fBSUNDAY\fR.
.TP 2m
\fB\-\-automated\-backup\-start\-times\fR=[\fISTART_TIMES\fR,...]
Comma\-separated list of times during the day to start a backup. At least one
start time must be provided. The start times are assumed to be in UTC and
required to be an exact hour in the format HH:00. (e.g.,
\f5\-\-automated\-backup\-start\-times=01:00,13:00\fR)
.TP 2m
\fB\-\-automated\-backup\-window\fR=\fITIMEOUT_PERIOD\fR
Length of the time window beginning at start time during which a backup can be
taken. If a backup does not succeed within this time window, it will be canceled
and considered failed. The backup window must be at least 5 minutes long. There
is no upper bound on the window. If not set, it will default to 1 hour.
.TP 2m
Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the automated backups. The 'AlloyDB Service Agent' service
account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The
arguments in this group can be used to specify the attributes of this resource.
.RS 2m
.TP 2m
\fB\-\-automated\-backup\-encryption\-key\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_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\-\-automated\-backup\-encryption\-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\-\-automated\-backup\-encryption\-key\-keyring\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING\fR
The KMS keyring of the key.
To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\fR on the command
line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\-keyring\fR on
the command line.
.RE
.sp
.TP 2m
\fB\-\-automated\-backup\-encryption\-key\-location\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION\fR
The Google Cloud location for the key.
To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\fR on the command
line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\-location\fR on
the command line.
.RE
.sp
.TP 2m
\fB\-\-automated\-backup\-encryption\-key\-project\fR=\fIAUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT\fR
The Google Cloud project for the key.
To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\fR on the command
line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-automated\-backup\-encryption\-key\-project\fR on
the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp
.RE
.sp
.TP 2m
Retention policy. If no retention policy is provided, all automated backups will
be retained.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-automated\-backup\-retention\-count\fR=\fIRETENTION_COUNT\fR
Number of most recent successful backups retained.
.TP 2m
\fB\-\-automated\-backup\-retention\-period\fR=\fIRETENTION_PERIOD\fR
Retention period of the backup relative to creation time. See \f5$ gcloud topic
datetimes\fR for information on duration formats.
.RE
.RE
.RE
.sp
.TP 2m
Continuous Backup configuration.
.RS 2m
.TP 2m
\fB\-\-continuous\-backup\-recovery\-window\-days\fR=\fIRECOVERY_PERIOD\fR
Recovery window of the log files and backups saved to support Continuous
Backups.
.TP 2m
\fB\-\-enable\-continuous\-backup\fR
Enables Continuous Backups on the cluster.
.TP 2m
Encryption configuration for Continuous Backups.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-continuous\-backup\-encryption\-key\fR
Clears the encryption configuration for Continuous Backups. Google default
encryption will be used for future Continuous Backups.
.TP 2m
Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the continuous backup. The 'AlloyDB Service Agent's service
account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The
arguments in this group can be used to specify the attributes of this resource.
.RS 2m
.TP 2m
\fB\-\-continuous\-backup\-encryption\-key\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_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\-\-continuous\-backup\-encryption\-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\-\-continuous\-backup\-encryption\-key\-keyring\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_KEYRING\fR
The KMS keyring of the key.
To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\fR on the
command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\-keyring\fR on
the command line.
.RE
.sp
.TP 2m
\fB\-\-continuous\-backup\-encryption\-key\-location\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_LOCATION\fR
The Google Cloud location for the key.
To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\fR on the
command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\-location\fR on
the command line.
.RE
.sp
.TP 2m
\fB\-\-continuous\-backup\-encryption\-key\-project\fR=\fICONTINUOUS_BACKUP_ENCRYPTION_KEY_PROJECT\fR
The Google Cloud project for the key.
To set the \f5kms\-project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\fR on the
command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-continuous\-backup\-encryption\-key\-project\fR on
the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp
.RE
.RE
.RE
.sp
.TP 2m
Configure a preferred maintenance window.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-maintenance\-window\-any\fR
Remove the user\-specified maintenance window.
.TP 2m
Specify preferred day and time for maintenance.
.RS 2m
.TP 2m
\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR
Day of week for maintenance window, in UTC time zone.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBMONDAY\fR, \fBTUESDAY\fR,
\fBWEDNESDAY\fR, \fBTHURSDAY\fR, \fBFRIDAY\fR, \fBSATURDAY\fR, \fBSUNDAY\fR.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR
Hour of day for maintenance window, in UTC time zone.
This flag argument must be specified if any of the other arguments in this group
are specified.
.RE
.RE
.sp
.TP 2m
Specify maintenance deny period.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-remove\-deny\-maintenance\-period\fR
Remove the deny maintenance period.
.TP 2m
Specify preferred day and time for maintenance deny period.
.RS 2m
.TP 2m
\fB\-\-deny\-maintenance\-period\-end\-date\fR=\fIDENY_MAINTENANCE_PERIOD_END_DATE\fR
Date when the deny maintenance period ends, that is 2020\-11\-01 or 11\-01 for
recurring.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-deny\-maintenance\-period\-start\-date\fR=\fIDENY_MAINTENANCE_PERIOD_START_DATE\fR
Date when the deny maintenance period begins, that is 2020\-11\-01 or 11\-01 for
recurring.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-deny\-maintenance\-period\-time\fR=\fIDENY_MAINTENANCE_PERIOD_TIME\fR
Time when the deny maintenance period starts and ends, for example 05:00, in UTC
time zone.
This flag argument must be specified if any of the other arguments in this group
are specified.
.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 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. These variants are also available:
.RS 2m
$ gcloud alloydb clusters update
.RE
.RS 2m
$ gcloud beta alloydb clusters update
.RE