Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
elasticache_increase_replica_count(ReplicationGroupId, NewReplicaCount,
ReplicaConfiguration, ApplyImmediately)
A list with the following syntax:
list(
ReplicationGroup = list(
ReplicationGroupId = "string",
Description = "string",
GlobalReplicationGroupInfo = list(
GlobalReplicationGroupId = "string",
GlobalReplicationGroupMemberRole = "string"
),
Status = "string",
PendingModifiedValues = list(
PrimaryClusterId = "string",
AutomaticFailoverStatus = "enabled"|"disabled",
Resharding = list(
SlotMigration = list(
ProgressPercentage = 123.0
)
),
AuthTokenStatus = "SETTING"|"ROTATING",
UserGroups = list(
UserGroupIdsToAdd = list(
"string"
),
UserGroupIdsToRemove = list(
"string"
)
)
),
MemberClusters = list(
"string"
),
NodeGroups = list(
list(
NodeGroupId = "string",
Status = "string",
PrimaryEndpoint = list(
Address = "string",
Port = 123
),
ReaderEndpoint = list(
Address = "string",
Port = 123
),
Slots = "string",
NodeGroupMembers = list(
list(
CacheClusterId = "string",
CacheNodeId = "string",
ReadEndpoint = list(
Address = "string",
Port = 123
),
PreferredAvailabilityZone = "string",
PreferredOutpostArn = "string",
CurrentRole = "string"
)
)
)
),
SnapshottingClusterId = "string",
AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
MultiAZ = "enabled"|"disabled",
ConfigurationEndpoint = list(
Address = "string",
Port = 123
),
SnapshotRetentionLimit = 123,
SnapshotWindow = "string",
ClusterEnabled = TRUE|FALSE,
CacheNodeType = "string",
AuthTokenEnabled = TRUE|FALSE,
AuthTokenLastModifiedDate = as.POSIXct(
"2015-01-01"
),
TransitEncryptionEnabled = TRUE|FALSE,
AtRestEncryptionEnabled = TRUE|FALSE,
MemberClustersOutpostArns = list(
"string"
),
KmsKeyId = "string",
ARN = "string",
UserGroupIds = list(
"string"
)
)
)
[required] The id of the replication group to which you want to add replica nodes.
The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
A list of ConfigureShard
objects that can be used to configure each
shard in a Redis (cluster mode enabled) replication group. The
ConfigureShard
has three members: NewReplicaCount
, NodeGroupId
,
and PreferredAvailabilityZones
.
[required] If True
, the number of replica nodes is increased immediately.
ApplyImmediately=False
is not currently supported.
svc$increase_replica_count(
ReplicationGroupId = "string",
NewReplicaCount = 123,
ReplicaConfiguration = list(
list(
NodeGroupId = "string",
NewReplicaCount = 123,
PreferredAvailabilityZones = list(
"string"
),
PreferredOutpostArns = list(
"string"
)
)
),
ApplyImmediately = TRUE|FALSE
)