.TH "GCLOUD_ALPHA_REDIS_CLUSTERS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha redis clusters update \- update Memorystore Cluster for Redis instance



.SH "SYNOPSIS"
.HP
\f5gcloud alpha redis clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-aof\-append\-fsync\fR=\fIAOF_APPEND_FSYNC\fR] [\fB\-\-async\fR] [\fB\-\-automated\-backup\-mode\fR=\fIAUTOMATED_BACKUP_MODE\fR] [\fB\-\-automated\-backup\-start\-time\fR=\fIAUTOMATED_BACKUP_START_TIME\fR] [\fB\-\-automated\-backup\-ttl\fR=\fIAUTOMATED_BACKUP_TTL\fR] [\fB\-\-deletion\-protection\fR] [\fB\-\-maintenance\-version\fR=\fIMAINTENANCE_VERSION\fR] [\fB\-\-node\-type\fR=\fINODE_TYPE\fR] [\fB\-\-persistence\-mode\fR=\fIPERSISTENCE_MODE\fR] [\fB\-\-rdb\-snapshot\-period\fR=\fIRDB_SNAPSHOT_PERIOD\fR] [\fB\-\-rdb\-snapshot\-start\-time\fR=\fIRDB_SNAPSHOT_START_TIME\fR] [\fB\-\-remove\-redis\-config\fR=[\fIKEY\fR,...]] [\fB\-\-replica\-count\fR=\fIREPLICA_COUNT\fR] [\fB\-\-shard\-count\fR=\fISHARD_COUNT\fR] [\fB\-\-simulate\-maintenance\-event\fR] [\fB\-\-update\-redis\-config\fR=\fIKEY\fR=\fIVALUE\fR] [\fB\-\-maintenance\-window\-any\fR\ |\ \fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR\ \fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update the metadata and/or configuration parameters of a Redis
cluster.

This command can fail for the following reasons:
.RS 2m
.IP "\(bu" 2m
The cluster specified does not exist.
.IP "\(bu" 2m
The active account does not have permission to update the given cluster.
.RE
.sp



.SH "EXAMPLES"

To update a Redis cluster with 5 shard and 2 replica, run:

.RS 2m
$ gcloud alpha redis clusters update my\-redis\-cluster \e
    \-\-shard\-count=5 \-\-replica\-count=2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- Arguments and flags that specify the Memorystore Redis
cluster you want to update. 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 \f5cluster\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
\fICLUSTER\fR

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

To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\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\-\-region\fR=\fIREGION\fR

The name of the Redis region of the cluster. Overrides the default redis/region
property value for this command invocation.


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


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-aof\-append\-fsync\fR=\fIAOF_APPEND_FSYNC\fR

Fsync configuration. \fIAOF_APPEND_FSYNC\fR must be one of:

.RS 2m
.TP 2m
\fBalways\fR
Redis explicitly calls fsync for every write command.

.TP 2m
\fBeverysec\fR
(default) Redis explicitly calls fsync every second.

.TP 2m
\fBno\fR
Redis will not explicitly call fsync.

.RE
.sp


.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-automated\-backup\-mode\fR=\fIAUTOMATED_BACKUP_MODE\fR

Automated backup mode. \fIAUTOMATED_BACKUP_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBdisabled\fR
(default) Automated backup is disabled.

.TP 2m
\fBenabled\fR
Automated backup is enabled.

.RE
.sp


.TP 2m
\fB\-\-automated\-backup\-start\-time\fR=\fIAUTOMATED_BACKUP_START_TIME\fR

One\-hour window when you want automated\-backup operations to start. Specify
the time in the format HH:00 on a 24\-hour cycle in UTC time.

.TP 2m
\fB\-\-automated\-backup\-ttl\fR=\fIAUTOMATED_BACKUP_TTL\fR

Time to live for automated backups. A backup will be deleted automatically after
the TTL is reached. It ranges from 1 day to 365 days. For example, "10d" for 10
days. If not specified, the default value is 35 days.

.TP 2m
\fB\-\-deletion\-protection\fR

Enable deletion protection for the Redis Cluster. Use
\f5\-\-deletion\-protection\fR/\f5\-\-no\-deletion\-protection\fR to
enable/disable it.

.TP 2m
\fB\-\-maintenance\-version\fR=\fIMAINTENANCE_VERSION\fR

The maintenance version of the cluster.

.TP 2m
\fB\-\-node\-type\fR=\fINODE_TYPE\fR

Node Type of the redis cluster Node. \fINODE_TYPE\fR must be one of:
\fBredis\-highmem\-medium\fR, \fBredis\-highmem\-xlarge\fR,
\fBredis\-shared\-core\-nano\fR, \fBredis\-standard\-small\fR.

.TP 2m
\fB\-\-persistence\-mode\fR=\fIPERSISTENCE_MODE\fR

Operation mode for persistence. \fIPERSISTENCE_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBaof\fR
AOF\-based persistence
.TP 2m
\fBdisabled\fR
Persistence mode is disabled
.TP 2m
\fBrdb\fR
RDB\-based persistence
.RE
.sp


.TP 2m
\fB\-\-rdb\-snapshot\-period\fR=\fIRDB_SNAPSHOT_PERIOD\fR

Attempted period between RDB snapshots. \fIRDB_SNAPSHOT_PERIOD\fR must be one
of:

.RS 2m
.TP 2m
\fB12h\fR
12 hours
.TP 2m
\fB1h\fR
1 hour
.TP 2m
\fB24h\fR
(default) 24 hours
.TP 2m
\fB6h\fR
6 hours
.RE
.sp


.TP 2m
\fB\-\-rdb\-snapshot\-start\-time\fR=\fIRDB_SNAPSHOT_START_TIME\fR

Date and time of the first snapshot in the ISO 1801 format, and alignment time
for future snapshots. For example, 2024\-01\-01T01:00:00Z. If not specified, the
current time will be used.

.TP 2m
\fB\-\-remove\-redis\-config\fR=[\fIKEY\fR,...]

A list of Redis Cluster config parameters to remove. Removing a non\-existent
config parameter is silently ignored.

.TP 2m
\fB\-\-replica\-count\fR=\fIREPLICA_COUNT\fR

The replica count of each shard.

.TP 2m
\fB\-\-shard\-count\fR=\fISHARD_COUNT\fR

The shard count of the cluster.

.TP 2m
\fB\-\-simulate\-maintenance\-event\fR

Trigger a simulation for maintenance event.

.TP 2m
\fB\-\-update\-redis\-config\fR=\fIKEY\fR=\fIVALUE\fR

A list of Redis Cluster config KEY=VALUE pairs to update. If a config parameter
is already set, its value is modified; otherwise a new Redis config parameter is
added.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-maintenance\-window\-any\fR

Removes the user\-specified maintenance window.

.TP 2m
\fB\-\-maintenance\-window\-day\fR=\fIMAINTENANCE_WINDOW_DAY\fR

The day of week when the window starts, e.g. \f5sunday\fR.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBfriday\fR, \fBmonday\fR,
\fBsaturday\fR, \fBsunday\fR, \fBthursday\fR, \fBtuesday\fR, \fBwednesday\fR.

.TP 2m
\fB\-\-maintenance\-window\-hour\fR=\fIMAINTENANCE_WINDOW_HOUR\fR

Hour of day (\f50\fR to \f523\fR) for the start of maintenance window, in UTC
time zone.


.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 "API REFERENCE"

This command uses the \fBredis/v1alpha1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/memorystore/docs/redis/



.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 redis clusters update
.RE

.RS 2m
$ gcloud beta redis clusters update
.RE