gcloud alpha redis clusters update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha redis clusters update - update Memorystore Cluster for Redis instance
- SYNOPSIS
gcloud alpha redis clusters update(CLUSTER:--region=REGION)[--aof-append-fsync=AOF_APPEND_FSYNC][--async][--automated-backup-mode=AUTOMATED_BACKUP_MODE][--automated-backup-start-time=AUTOMATED_BACKUP_START_TIME][--automated-backup-ttl=AUTOMATED_BACKUP_TTL][--deletion-protection][--maintenance-version=MAINTENANCE_VERSION][--node-type=NODE_TYPE][--persistence-mode=PERSISTENCE_MODE][--rdb-snapshot-period=RDB_SNAPSHOT_PERIOD][--rdb-snapshot-start-time=RDB_SNAPSHOT_START_TIME][--remove-redis-config=[KEY,…]][--replica-count=REPLICA_COUNT][--shard-count=SHARD_COUNT][--simulate-maintenance-event][--update-redis-config=KEY=VALUE][--maintenance-window-any|--maintenance-window-day=MAINTENANCE_WINDOW_DAY--maintenance-window-hour=MAINTENANCE_WINDOW_HOUR][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Update the metadata and/or configuration parameters of aRedis cluster.This command can fail for the following reasons:
- The cluster specified does not exist.
- The active account does not have permission to update the given cluster.
- EXAMPLES
- To update a Redis cluster with 5 shard and 2 replica, run:
gcloudalpharedisclustersupdatemy-redis-cluster--shard-count=5--replica-count=2 - POSITIONAL ARGUMENTS
- Cluster resource - Arguments and flags that specify the Memorystore Rediscluster you want to update. The arguments in this group can be used to specifythe attributes of this resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.
To set the
projectattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CLUSTER- ID of the cluster or fully qualified identifier for the cluster.
To set the
clusterattribute:- provide the argument
clusteron the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- The name of the Redis region of the cluster. Overrides the default redis/regionproperty value for this command invocation.To set the
regionattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--regionon the command line; - set the property
redis/region.
- provide the argument
- provide the argument
- Cluster resource - Arguments and flags that specify the Memorystore Rediscluster you want to update. The arguments in this group can be used to specifythe attributes of this resource. (NOTE) Some attributes are not given argumentsin this group but can be set in other ways.
- FLAGS
--aof-append-fsync=AOF_APPEND_FSYNC- Fsync configuration.
AOF_APPEND_FSYNCmust be one of:always- Redis explicitly calls fsync for every write command.
everysec- (default) Redis explicitly calls fsync every second.
no- Redis will not explicitly call fsync.
--async- Return immediately, without waiting for the operation in progress to complete.
--automated-backup-mode=AUTOMATED_BACKUP_MODE- Automated backup mode.
AUTOMATED_BACKUP_MODEmust be oneof:disabled- (default) Automated backup is disabled.
enabled- Automated backup is enabled.
--automated-backup-start-time=AUTOMATED_BACKUP_START_TIME- One-hour window when you want automated-backup operations to start. Specify thetime in the format HH:00 on a 24-hour cycle in UTC time.
--automated-backup-ttl=AUTOMATED_BACKUP_TTL- Time to live for automated backups. A backup will be deleted automatically afterthe TTL is reached. It ranges from 1 day to 365 days. For example, "10d" for 10days. If not specified, the default value is 35 days.
--deletion-protection- Enable deletion protection for the Redis Cluster. Use
--deletion-protection/--no-deletion-protectiontoenable/disable it. --maintenance-version=MAINTENANCE_VERSION- The maintenance version of the cluster.
--node-type=NODE_TYPE- Node Type of the redis cluster Node.
NODE_TYPEmust beone of:redis-highmem-medium,redis-highmem-xlarge,redis-shared-core-nano,redis-standard-small. --persistence-mode=PERSISTENCE_MODE- Operation mode for persistence.
PERSISTENCE_MODEmust beone of:aof- AOF-based persistence
disabled- Persistence mode is disabled
rdb- RDB-based persistence
--rdb-snapshot-period=RDB_SNAPSHOT_PERIOD- Attempted period between RDB snapshots.
RDB_SNAPSHOT_PERIODmust be one of:12h- 12 hours
1h- 1 hour
24h- (default) 24 hours
6h- 6 hours
--rdb-snapshot-start-time=RDB_SNAPSHOT_START_TIME- Date and time of the first snapshot in the ISO 1801 format, and alignment timefor future snapshots. For example, 2024-01-01T01:00:00Z. If not specified, thecurrent time will be used.
--remove-redis-config=[KEY,…]- A list of Redis Cluster config parameters to remove. Removing a non-existentconfig parameter is silently ignored.
--replica-count=REPLICA_COUNT- The replica count of each shard.
--shard-count=SHARD_COUNT- The shard count of the cluster.
--simulate-maintenance-event- Trigger a simulation for maintenance event.
--update-redis-config=KEY=VALUE- A list of Redis Cluster config KEY=VALUE pairs to update. If a config parameteris already set, its value is modified; otherwise a new Redis config parameter isadded.
- At most one of these can be specified:
--maintenance-window-any- Removes the user-specified maintenance window.
--maintenance-window-day=MAINTENANCE_WINDOW_DAY- The day of week when the window starts, e.g.
sunday.MAINTENANCE_WINDOW_DAYmust be one of:friday,monday,saturday,sunday,thursday,tuesday,wednesday. --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR- Hour of day (
0to23) for the start of maintenancewindow, in UTC time zone.
- 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
$gcloud helpfor details. - API REFERENCE
- This command uses the
redis/v1alpha1API. The full documentationfor this API can be found at:https://cloud.google.com/memorystore/docs/redis/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudredisclustersupdategcloudbetaredisclustersupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-14 UTC.