Skip to contents

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group

Source: R/elasticache_operations.R
elasticache_decrease_replica_count.Rd

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

See https://www.paws-r-sdk.com/docs/elasticache_decrease_replica_count/ for full documentation.

Usage

elasticache_decrease_replica_count(
  ReplicationGroupId,
  NewReplicaCount = NULL,
  ReplicaConfiguration = NULL,
  ReplicasToRemove = NULL,
  ApplyImmediately
)

Arguments

ReplicationGroupId

[required] The id of the replication group from which you want to remove replica nodes.

NewReplicaCount

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Valkey or Redis OSS (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

ReplicaConfiguration

A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

ReplicasToRemove

A list of the node ids to remove from the replication group or node group (shard).

ApplyImmediately

[required] If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.