class Aws::ElastiCache::Types::ConfigureShard

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

@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"],
      preferred_outpost_arns: ["String"],
    }

@!attribute [rw] node_group_id

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

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

@!attribute [rw] new_replica_count

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)
@return [Integer]

@!attribute [rw] preferred_availability_zones

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.
@return [Array<String>]

@!attribute [rw] preferred_outpost_arns

The outpost ARNs in which the cache cluster is created.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ConfigureShard AWS API Documentation

Constants

SENSITIVE