gcloud-help/gcloud/redis/clusters/update

NAME
    gcloud redis clusters update - update Memorystore Cluster for Redis
        instance

SYNOPSIS
    gcloud redis clusters update (CLUSTER : --region=REGION)
        [--aof-append-fsync=AOF_APPEND_FSYNC] [--async] [--deletion-protection]
        [--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] [--update-redis-config=KEY=VALUE]
        [--maintenance-window-any
          | --maintenance-window-day=MAINTENANCE_WINDOW_DAY
          --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Update the metadata and/or configuration parameters of a Redis 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:

        $ gcloud redis clusters update my-redis-cluster --shard-count=5 \
            --replica-count=2

POSITIONAL ARGUMENTS
     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 project attribute:
      ◆ provide the argument cluster 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.

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

          To set the cluster attribute:
          ▸ provide the argument cluster on the command line.

          This positional argument must be specified if any of the other
          arguments in this group are specified.

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

          To set the region attribute:
          ▸ provide the argument cluster on the command line with a fully
            specified name;
          ▸ provide the argument --region on the command line;
          ▸ set the property redis/region.

FLAGS
     --aof-append-fsync=AOF_APPEND_FSYNC
        Fsync configuration. AOF_APPEND_FSYNC must 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.

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

     --persistence-mode=PERSISTENCE_MODE
        Operation mode for persistence. PERSISTENCE_MODE must be one 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_PERIOD must 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 time for future snapshots. For example, 2024-01-01T01:00:00Z.
        If not specified, the current time will be used.

     --remove-redis-config=[KEY,...]
        A list of Redis Cluster config parameters to remove. Removing a
        non-existent config parameter is silently ignored.

     --replica-count=REPLICA_COUNT
        The replica count of each shard.

     --shard-count=SHARD_COUNT
        The shard count of the cluster.

     --update-redis-config=KEY=VALUE
        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.

     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_DAY must be one of: friday, monday, saturday,
          sunday, thursday, tuesday, wednesday.

       --maintenance-window-hour=MAINTENANCE_WINDOW_HOUR
          Hour of day (0 to 23) for the start of maintenance window, 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 help for details.

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

NOTES
    These variants are also available:

        $ gcloud alpha redis clusters update

        $ gcloud beta redis clusters update