Class: Aws::ElastiCache::Types::DecreaseReplicaCountMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElastiCache::Types::DecreaseReplicaCountMessage
- Defined in:
- gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb
Overview
When making an API call, you may pass DecreaseReplicaCountMessage data as a 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
}
Constant Summary collapse
- SENSITIVE =
[]
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.
3021 3022 3023 3024 3025 3026 3027 3028 3029 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3021 class DecreaseReplicaCountMessage < Struct.new( :replication_group_id, :new_replica_count, :replica_configuration, :replicas_to_remove, :apply_immediately) SENSITIVE = [] include Aws::Structure end |
#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)
3021 3022 3023 3024 3025 3026 3027 3028 3029 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3021 class DecreaseReplicaCountMessage < Struct.new( :replication_group_id, :new_replica_count, :replica_configuration, :replicas_to_remove, :apply_immediately) SENSITIVE = [] include Aws::Structure end |
#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
.
3021 3022 3023 3024 3025 3026 3027 3028 3029 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3021 class DecreaseReplicaCountMessage < Struct.new( :replication_group_id, :new_replica_count, :replica_configuration, :replicas_to_remove, :apply_immediately) SENSITIVE = [] include Aws::Structure end |
#replicas_to_remove ⇒ Array<String>
A list of the node ids to remove from the replication group or node group (shard).
3021 3022 3023 3024 3025 3026 3027 3028 3029 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3021 class DecreaseReplicaCountMessage < Struct.new( :replication_group_id, :new_replica_count, :replica_configuration, :replicas_to_remove, :apply_immediately) SENSITIVE = [] include Aws::Structure end |
#replication_group_id ⇒ String
The id of the replication group from which you want to remove replica nodes.
3021 3022 3023 3024 3025 3026 3027 3028 3029 |
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3021 class DecreaseReplicaCountMessage < Struct.new( :replication_group_id, :new_replica_count, :replica_configuration, :replicas_to_remove, :apply_immediately) SENSITIVE = [] include Aws::Structure end |