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

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

Overview

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:

Constant Summary collapse

SENSITIVE = 
[]

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 Valkey or Redis OSS replication group you are working with.

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

  • Valkey or Redis OSS (cluster mode disabled)

    • If Multi-AZ: 1

    • If Multi-AZ: 0

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

Returns:

  • (Integer) 


1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1488

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones,
  :preferred_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#node_group_id ⇒ String

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

Returns:

  • (String) 


1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1488

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones,
  :preferred_outpost_arns)
  SENSITIVE = []
  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 selects the availability zone for each of the replicas.

Returns:

  • (Array<String>) 


1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1488

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones,
  :preferred_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_outpost_arns ⇒ Array<String>

The outpost ARNs in which the cache cluster is created.

Returns:

  • (Array<String>) 


1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1488

class ConfigureShard < Struct.new(
  :node_group_id,
  :new_replica_count,
  :preferred_availability_zones,
  :preferred_outpost_arns)
  SENSITIVE = []
  include Aws::Structure
end