Package software.amazon.awscdk.services.elasticache

Interface CfnReplicationGroup.NodeGroupConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReplicationGroup.NodeGroupConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnReplicationGroup

@Stability(Stable)
public static interface CfnReplicationGroup.NodeGroupConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 NodeGroupConfigurationProperty nodeGroupConfigurationProperty = NodeGroupConfigurationProperty.builder()
         .nodeGroupId("nodeGroupId")
         .primaryAvailabilityZone("primaryAvailabilityZone")
         .replicaAvailabilityZones(List.of("replicaAvailabilityZones"))
         .replicaCount(123)
         .slots("slots")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReplicationGroup.NodeGroupConfigurationProperty.Builder	A builder for CfnReplicationGroup.NodeGroupConfigurationProperty
static final class	CfnReplicationGroup.NodeGroupConfigurationProperty.Jsii$Proxy	An implementation for CfnReplicationGroup.NodeGroupConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnReplicationGroup.NodeGroupConfigurationProperty.Builder	builder()
default String	getNodeGroupId()	Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
default String	getPrimaryAvailabilityZone()	The Availability Zone where the primary node of this node group (shard) is launched.
default List<String>	getReplicaAvailabilityZones()	A list of Availability Zones to be used for the read replicas.
default Number	getReplicaCount()	The number of read replica nodes in this node group (shard).
default String	getSlots()	A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNodeGroupId

@Stability(Stable)
@Nullable
default String getNodeGroupId()

Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-nodegroupid

getPrimaryAvailabilityZone

@Stability(Stable)
@Nullable
default String getPrimaryAvailabilityZone()

The Availability Zone where the primary node of this node group (shard) is launched.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-primaryavailabilityzone

getReplicaAvailabilityZones

@Stability(Stable)
@Nullable
default List<String> getReplicaAvailabilityZones()

A list of Availability Zones to be used for the read replicas.

The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicaavailabilityzones

getReplicaCount

@Stability(Stable)
@Nullable
default Number getReplicaCount()

The number of read replica nodes in this node group (shard).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicacount

getSlots

@Stability(Stable)
@Nullable
default String getSlots()

A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot.

The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383 .

If you don't specify a value, ElastiCache allocates keys equally among each slot.

When you use an UseOnlineResharding update policy to update the number of node groups without interruption, ElastiCache evenly distributes the keyspaces between the specified number of slots. This cannot be updated later. Therefore, after updating the number of node groups in this way, you should remove the value specified for the Slots property of each NodeGroupConfiguration from the stack template, as it no longer reflects the actual values in each node group. For more information, see UseOnlineResharding Policy .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-slots

builder

@Stability(Stable)
static CfnReplicationGroup.NodeGroupConfigurationProperty.Builder builder()

Returns:

a CfnReplicationGroup.NodeGroupConfigurationProperty.Builder of CfnReplicationGroup.NodeGroupConfigurationProperty