Package software.amazon.awscdk.cfnpropertymixins.services.elasticache

Class CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticache.CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty>

Enclosing interface:

CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty

@Stability(Stable)
public static final class CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty>

A builder for CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty	build()	Builds the configured instance.
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder	nodeGroupId(String nodeGroupId)	Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getNodeGroupId()
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder	primaryAvailabilityZone(String primaryAvailabilityZone)	Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getPrimaryAvailabilityZone()
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder	replicaAvailabilityZones(List<String> replicaAvailabilityZones)	Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getReplicaAvailabilityZones()
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder	replicaCount(Number replicaCount)	Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getReplicaCount()
CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder	slots(String slots)	Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getSlots()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

nodeGroupId

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder nodeGroupId(String nodeGroupId)

Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getNodeGroupId()

Parameters:

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

Returns:

this

primaryAvailabilityZone

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder primaryAvailabilityZone(String primaryAvailabilityZone)

Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getPrimaryAvailabilityZone()

Parameters:

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

Returns:

this

replicaAvailabilityZones

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder replicaAvailabilityZones(List<String> replicaAvailabilityZones)

Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getReplicaAvailabilityZones()

Parameters:

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

Returns:

this

replicaCount

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder replicaCount(Number replicaCount)

Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getReplicaCount()

Parameters:

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

Returns:

this

slots

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.Builder slots(String slots)

Sets the value of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty.getSlots()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty>

Returns:

a new instance of CfnReplicationGroupPropsMixin.NodeGroupConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided