.TH "GCLOUD_BETA_REDIS_INSTANCES_UPDATE" 1



.SH "NAME"
.HP
gcloud beta redis instances update \- update Memorystore Redis instances



.SH "SYNOPSIS"
.HP
\f5gcloud beta redis instances update\fR (\fIINSTANCE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-enable\-auth\fR] [\fB\-\-maintenance\-version\fR=\fIMAINTENANCE_VERSION\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\-\-read\-replicas\-mode\fR=\fIREAD_REPLICAS_MODE\fR] [\fB\-\-remove\-redis\-config\fR=[\fIKEY\fR,...]] [\fB\-\-replica\-count\fR=\fIREPLICA_COUNT\fR] [\fB\-\-secondary\-ip\-range\fR=\fISECONDARY_IP_RANGE\fR] [\fB\-\-size\fR=\fISIZE\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-update\-redis\-config\fR=\fIKEY\fR=\fIVALUE\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\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(BETA)\fR Update the metadata and/or configuration parameters of a Redis
instance.

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



.SH "EXAMPLES"

To update a Redis instance with the name \f5my\-redis\-instance\fR to have the
display name "Cache for Foo Service", and add the two labels, \f5env\fR and
\f5service\fR, run:

.RS 2m
$ gcloud beta redis instances update my\-redis\-instance \e
    \-\-display\-name="Cache for Foo Service" \e
    \-\-update\-labels=env=test,service=foo
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Instance resource \- Arguments and flags that specify the Memorystore Redis
instance 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 \f5instance\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
\fIINSTANCE\fR

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

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\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 instance. 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 \f5instance\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\-\-async\fR

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

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

A human\-readable name for the instance.

.TP 2m
\fB\-\-enable\-auth\fR

Enables Redis AUTH for the instance.

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

Specifies which maintenance version to apply to your instance during
self\-service maintenance. To view the available maintenance versions for your
instance, run \f5gcloud redis instances describe [INSTANCE_ID]\fR. Acceptable
values for this flag are either \f5current_default\fR or one of the specific
versions listed by the describe command. If you pass the value
\f5current_default\fR, the Memorystore updates to the most recent available
maintenance version during self service maintenance.

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

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

.RS 2m
.TP 2m
\fBdisabled\fR
RDB mode is disabled
.TP 2m
\fBrdb\fR
Automatic RDB persistence
.RE
.sp


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

The 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
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, 2022\-11\-02T03:00:00Z.

.TP 2m
\fB\-\-read\-replicas\-mode\fR=\fIREAD_REPLICAS_MODE\fR

Read replicas mode used by the instance. Only works against standard tier
instances with 5GB and above provisioned capacity and Redis version 5.0 and
above. This is an irreversible update i.e. Read replicas can not be disabled for
the instance once it is enabled. Also this update is exclusive and cannot be
clubbed with other update operations. \fIREAD_REPLICAS_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBread\-replicas\-disabled\fR
If read replica is not enabled on the instance, no changes are done. If read
replica is enabled for the instance, update operation fails

.TP 2m
\fBread\-replicas\-enabled\fR
Read replica is enabled for the instance if not already enabled. Read endpoint
will be provided and the instance can scale up and down the number of replicas.

.RE
.sp


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

A list of Redis 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 the instance. Valid from 0 to 5.

.TP 2m
\fB\-\-secondary\-ip\-range\fR=\fISECONDARY_IP_RANGE\fR

Required only when read\-replicas\-mode is enabled on the instance. The CIDR
range of internal addresses that are reserved for this instance. For example,
10.0.0.0/28 or 192.168.0.0/28. Range must be unique and non\-overlapping with
existing ranges in the network. If value 'auto' passed, the service will
automatically pick an available range.

.TP 2m
\fB\-\-size\fR=\fISIZE\fR

The memory size of the instance in GiB.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

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

A list of Redis config KEY=VALUE pairs to update according to
http://cloud.google.com/memorystore/docs/reference/redis\-configs. If a config
parameter is already set, its value is modified; otherwise a new Redis config
parameter is added. Currently, the only supported parameters are:

Redis version 3.2 and newer: maxmemory\-policy, notify\-keyspace\-events,
timeout.

Redis version 4.0 and newer: activedefrag, lfu\-decay\-time, lfu\-log\-factor,
maxmemory\-gb.

Redis version 5.0 and newer: stream\-node\-max\-bytes,
stream\-node\-max\-entries.

Redis version 7.0 and newer: maxmemory\-clients, lazyfree\-lazy\-eviction,
lazyfree\-lazy\-expire, lazyfree\-lazy\-user\-del, lazyfree\-lazy\-user\-flush.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud beta redis instances update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud beta redis instances update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

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

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.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

Day of week for maintenance window, in UTC time zone. MAINTENANCE_WINDOW_DAY
must be one of: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY.
\fIMAINTENANCE_WINDOW_DAY\fR must be one of: \fBday\-of\-week\-unspecified\fR,
\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 (0 to 23) for 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/v1beta1\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 beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud redis instances update
.RE

.RS 2m
$ gcloud alpha redis instances update
.RE