gcloud_alpha_redis_instances_update (1)
NAME
- gcloud alpha redis instances update - update Memorystore Redis instances
SYNOPSIS
-
gcloud alpha redis instances update (INSTANCE : --region=REGION) [--async] [--display-name=DISPLAY_NAME] [--remove-redis-config=[KEY,...]] [--size=SIZE] [--update-labels=[KEY=VALUE,...]] [--update-redis-config=KEY=VALUE] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update the metadata and/or configuration parameters of a Redis
This command can fail for the following reasons:
-
- *
- The instance specified does not exist.
- *
- The active account does not have permission to update the given instance.
POSITIONAL ARGUMENTS
-
-
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 [project] attribute:
provide the argument [instance] 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.
-
- INSTANCE
-
ID of the instance or fully qualified identifier for the instance. This
positional must be specified if any of the other arguments in this group are
specified.
- --region=REGION
-
The name of the Redis region of the instance. Overrides the default redis/region
property value for this command invocation.
-
-
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 [project] attribute:
provide the argument [instance] 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.
FLAGS
-
- --async
-
Display information about the operation in progress, without waiting for the
operation to complete.
- --display-name=DISPLAY_NAME
-
A human-readable name for the instance.
- --remove-redis-config=[KEY,...]
-
A list of Redis config parameters to remove. Removing a non-existent config
parameter is silently ignored.
- --size=SIZE
-
The memory size of the instance in GiB.
- --update-labels=[KEY=VALUE,...]
-
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 (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
- --update-redis-config=KEY=VALUE
-
A list of Redis config KEY=VALUE pairs to update according to
redis.io/topics/config 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: maxmemory-policy, notify-keyspace-events.
-
At most one of these may be specified:
-
- --clear-labels
-
Remove all labels. If --update-labels is also specified then
--clear-labels is applied first.
For example, to remove all labels:
- $ gcloud alpha redis instances update --clear-labels
To set the labels to exactly "foo" and "baz":
-
$ gcloud alpha redis instances update --clear-labels \
--update-labels foo=bar,baz=qux
- --remove-labels=[KEY,...]
-
List of label keys to remove. If a label does not exist it is silently ignored.
-
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the redis/v1 API. The full documentation for this API can be found at: cloud.google.com/memorystore/docs/redis
EXAMPLES
To update a Redis instance with the name my-redis-instance to have the display name "Cache for Foo Service", and add the two labels, env and service, run:
-
$ gcloud alpha redis instances update my-redis-instance \
--display-name="Cache for Foo Service" \
--update-labels=env=test,service=foo
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support These variants are also available:
- $ gcloud redis instances update $ gcloud beta redis instances update