Skip to content

/AWS1/CL_ECACONFIGURESHARD

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_nodegroupid TYPE /AWS1/ECAALLOWEDNODEGROUPID /AWS1/ECAALLOWEDNODEGROUPID

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.

iv_newreplicacount TYPE /AWS1/ECAINTEGER /AWS1/ECAINTEGER

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)

Optional arguments:

it_preferredazs TYPE /AWS1/CL_ECAPREFERREDAZLIST_W=>TT_PREFERREDAZLIST TT_PREFERREDAZLIST

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.

it_preferredoutpostarns TYPE /AWS1/CL_ECAPREFERREDOUTPOST00=>TT_PREFERREDOUTPOSTARNLIST TT_PREFERREDOUTPOSTARNLIST

The outpost ARNs in which the cache cluster is created.

Queryable Attributes

NodeGroupId

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.

Accessible with the following methods

Method Description
GET_NODEGROUPID() Getter for NODEGROUPID, with configurable default
ASK_NODEGROUPID() Getter for NODEGROUPID w/ exceptions if field has no value
HAS_NODEGROUPID() Determine if NODEGROUPID has a value

NewReplicaCount

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)

Accessible with the following methods

Method Description
GET_NEWREPLICACOUNT() Getter for NEWREPLICACOUNT, with configurable default
ASK_NEWREPLICACOUNT() Getter for NEWREPLICACOUNT w/ exceptions if field has no val
HAS_NEWREPLICACOUNT() Determine if NEWREPLICACOUNT has a value

PreferredAvailabilityZones

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.

Accessible with the following methods

Method Description
GET_PREFERREDAZS() Getter for PREFERREDAVAILABILITYZONES, with configurable def
ASK_PREFERREDAZS() Getter for PREFERREDAVAILABILITYZONES w/ exceptions if field
HAS_PREFERREDAZS() Determine if PREFERREDAVAILABILITYZONES has a value

PreferredOutpostArns

The outpost ARNs in which the cache cluster is created.

Accessible with the following methods

Method Description
GET_PREFERREDOUTPOSTARNS() Getter for PREFERREDOUTPOSTARNS, with configurable default
ASK_PREFERREDOUTPOSTARNS() Getter for PREFERREDOUTPOSTARNS w/ exceptions if field has n
HAS_PREFERREDOUTPOSTARNS() Determine if PREFERREDOUTPOSTARNS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_REPLICACONFIGURATIONLIST

TYPES TT_REPLICACONFIGURATIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECACONFIGURESHARD WITH DEFAULT KEY
.