ModifyReplicationGroupShardConfigurationMessage
import type { ModifyReplicationGroupShardConfigurationMessage } from "https://aws-api.deno.dev/v0.3/services/elasticache.ts?docs=full";
Represents the input for a ModifyReplicationGroupShardConfiguration
operation.
§Properties
Indicates that the shard reconfiguration process begins immediately.
At present, the only permitted value for this parameter is true
.
Value: true
The number of node groups (shards) that results from the modification of the shard configuration.
If the value of NodeGroupCount
is less than the current number of node groups (shards), then either NodeGroupsToRemove
or NodeGroupsToRetain
is required.
NodeGroupsToRemove
is a list of NodeGroupId
s to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
from the cluster.
If the value of NodeGroupCount
is less than the current number of node groups (shards), then either NodeGroupsToRemove
or NodeGroupsToRetain
is required.
NodeGroupsToRetain
is a list of NodeGroupId
s to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain
from the cluster.
The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
Specifies the preferred availability zones for each node group in the cluster.
If the value of NodeGroupCount
is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards.
If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount
is greater than the current number of node groups (shards).