/AWS1/CL_ECA=>DECREASEREPLICACOUNT()
¶
About DecreaseReplicaCount¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_REPLICATIONGROUPID
TYPE /AWS1/ECASTRING
/AWS1/ECASTRING
¶
The id of the replication group from which you want to remove replica nodes.
IV_APPLYIMMEDIATELY
TYPE /AWS1/ECABOOLEAN
/AWS1/ECABOOLEAN
¶
If
True
, the number of replica nodes is decreased immediately.ApplyImmediately=False
is not currently supported.
Optional arguments:¶
IV_NEWREPLICACOUNT
TYPE /AWS1/ECAINTEGEROPTIONAL
/AWS1/ECAINTEGEROPTIONAL
¶
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)
IT_REPLICACONFIGURATION
TYPE /AWS1/CL_ECACONFIGURESHARD=>TT_REPLICACONFIGURATIONLIST
TT_REPLICACONFIGURATIONLIST
¶
A list of
ConfigureShard
objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. TheConfigureShard
has three members:NewReplicaCount
,NodeGroupId
, andPreferredAvailabilityZones
.
IT_REPLICASTOREMOVE
TYPE /AWS1/CL_ECAREMOVERPLSLIST_W=>TT_REMOVEREPLICASLIST
TT_REMOVEREPLICASLIST
¶
A list of the node ids to remove from the replication group or node group (shard).