Class: Aws::ElastiCache::Types::DecreaseReplicaCountMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Note:

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"],
    },
  ],
  replicas_to_remove: ["String"],
  apply_immediately: false, # required
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Returns:

  • (Boolean) 


2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

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)

Returns:

  • (Integer) 


2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

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.

Returns:



2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

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).

Returns:

  • (Array<String>) 


2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

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.

Returns:

  • (String) 


2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

class DecreaseReplicaCountMessage < Struct.new(
  :replication_group_id,
  :new_replica_count,
  :replica_configuration,
  :replicas_to_remove,
  :apply_immediately)
  SENSITIVE = []
  include Aws::Structure
end