You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ElastiCache::Types::DecreaseReplicaCountMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElastiCache::Types::DecreaseReplicaCountMessage
- Defined in:
- (unknown)
Overview
When passing DecreaseReplicaCountMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
replication_group_id: "String", # required
new_replica_count: 1,
replica_configuration: [
{
node_group_id: "AllowedNodeGroupId", # required
new_replica_count: 1, # required
preferred_availability_zones: ["String"],
preferred_outpost_arns: ["String"],
},
],
replicas_to_remove: ["String"],
apply_immediately: false, # required
}
Instance Attribute Summary collapse
-
#apply_immediately ⇒ Boolean
If
True
, the number of replica nodes is decreased immediately. -
#new_replica_count ⇒ Integer
The number of read replica nodes you want at the completion of this operation.
-
#replica_configuration ⇒ Array<Types::ConfigureShard>
A list of
ConfigureShard
objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. -
#replicas_to_remove ⇒ Array<String>
A list of the node ids to remove from the replication group or node group (shard).
-
#replication_group_id ⇒ String
The id of the replication group from which you want to remove replica nodes.
Instance Attribute Details
#apply_immediately ⇒ Boolean
If True
, the number of replica nodes is decreased immediately.
ApplyImmediately=False
is not currently supported.
#new_replica_count ⇒ Integer
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.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
#replica_configuration ⇒ Array<Types::ConfigureShard>
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
.
#replicas_to_remove ⇒ Array<String>
A list of the node ids to remove from the replication group or node group (shard).
#replication_group_id ⇒ String
The id of the replication group from which you want to remove replica nodes.