You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConfigureShard as input to an Aws::Client method, you can use a vanilla Hash:

{
  node_group_id: "AllowedNodeGroupId", # required
  new_replica_count: 1, # required
  preferred_availability_zones: ["String"],
  preferred_outpost_arns: ["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: 1

    • If Multi-AZ: 0

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

Returns:

  • (Integer) —

    The number of replicas you want in this node group at the end of this operation.

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

Returns:

  • (String) —

    The 4-digit id for the node group you are configuring.

#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>) —

    A list of PreferredAvailabilityZone strings that specify which availability zones the replication group\'s nodes are to be in.

#preferred_outpost_arns ⇒ Array<String>

The outpost ARNs in which the cache cluster is created.

Returns:

  • (Array<String>) —

    The outpost ARNs in which the cache cluster is created.