Class: Aws::ElastiCache::Types::ConfigureShard

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

Overview

Note:

When making an API call, you may pass ConfigureShard data as a hash:

{
  node_group_id: "AllowedNodeGroupId", # required
  new_replica_count: 1, # required
  preferred_availability_zones: ["String"],
}

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#new_replica_count ⇒ Integer

The number of replicas you want in this node group at the end of this operation. The maximum value for ‘NewReplicaCount` is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ with Automatic Failover is enabled: 1

    • If Multi-AZ with Automatic Failover is not enable: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Returns:

  • (Integer) 


998
999
1000
1001
1002
1003
 
# File 'lib/aws-sdk-elasticache/types.rb', line 998

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones)
  include Aws::Structure
end

#node_group_id ⇒ String

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)‘s node group’s (shard’s) id, see [Finding a Shard’s Id].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html

Returns:

  • (String) 


998
999
1000
1001
1002
1003
 
# File 'lib/aws-sdk-elasticache/types.rb', line 998

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones)
  include Aws::Structure
end

#preferred_availability_zones ⇒ Array<String>

A list of ‘PreferredAvailabilityZone` strings that specify which availability zones the replication group’s nodes are to be in. The nummber of ‘PreferredAvailabilityZone` values must equal the value of `NewReplicaCount` plus 1 to account for the primary node. If this member of `ReplicaConfiguration` is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

Returns:

  • (Array<String>) 


998
999
1000
1001
1002
1003
 
# File 'lib/aws-sdk-elasticache/types.rb', line 998

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones)
  include Aws::Structure
end