Package software.amazon.awscdk.services.dax

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.dax.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

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

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method	Description
CfnCluster.Builder	availabilityZones(List<String> availabilityZones)	The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
CfnCluster	build()
CfnCluster.Builder	clusterEndpointEncryptionType(String clusterEndpointEncryptionType)	The encryption type of the cluster's endpoint.
CfnCluster.Builder	clusterName(String clusterName)	The name of the DAX cluster.
static CfnCluster.Builder	create(software.constructs.Construct scope, String id)
CfnCluster.Builder	description(String description)	The description of the cluster.
CfnCluster.Builder	iamRoleArn(String iamRoleArn)	A valid Amazon Resource Name (ARN) that identifies an IAM role.
CfnCluster.Builder	nodeType(String nodeType)	The node type for the nodes in the cluster.
CfnCluster.Builder	notificationTopicArn(String notificationTopicArn)	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
CfnCluster.Builder	parameterGroupName(String parameterGroupName)	The parameter group to be associated with the DAX cluster.
CfnCluster.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	A range of time when maintenance of DAX cluster software will be performed.
CfnCluster.Builder	replicationFactor(Number replicationFactor)	The number of nodes in the DAX cluster.
CfnCluster.Builder	securityGroupIds(List<String> securityGroupIds)	A list of security group IDs to be assigned to each node in the DAX cluster.
CfnCluster.Builder	sseSpecification(IResolvable sseSpecification)	Represents the settings used to enable server-side encryption on the cluster.
CfnCluster.Builder	sseSpecification(CfnCluster.SSESpecificationProperty sseSpecification)	Represents the settings used to enable server-side encryption on the cluster.
CfnCluster.Builder	subnetGroupName(String subnetGroupName)	The name of the subnet group to be used for the replication group.
CfnCluster.Builder	tags(Object tags)	A set of tags to associate with the DAX cluster.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCluster.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCluster.Builder.

iamRoleArn

@Stability(Stable)
public CfnCluster.Builder iamRoleArn(String iamRoleArn)

A valid Amazon Resource Name (ARN) that identifies an IAM role.

At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Parameters:

iamRoleArn - A valid Amazon Resource Name (ARN) that identifies an IAM role. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn

nodeType

@Stability(Stable)
public CfnCluster.Builder nodeType(String nodeType)

The node type for the nodes in the cluster.

(All nodes in a DAX cluster are of the same type.)

Parameters:

nodeType - The node type for the nodes in the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype

replicationFactor

@Stability(Stable)
public CfnCluster.Builder replicationFactor(Number replicationFactor)

The number of nodes in the DAX cluster.

A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor .

AWS recommends that you have at least two read replicas per cluster.

Parameters:

replicationFactor - The number of nodes in the DAX cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor

availabilityZones

@Stability(Stable)
public CfnCluster.Builder availabilityZones(List<String> availabilityZones)

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.

If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

Parameters:

availabilityZones - The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-availabilityzones

clusterEndpointEncryptionType

@Stability(Stable)
public CfnCluster.Builder clusterEndpointEncryptionType(String clusterEndpointEncryptionType)

The encryption type of the cluster's endpoint. Available values are:.

• NONE - The cluster's endpoint will be unencrypted.
• TLS - The cluster's endpoint will be encrypted with Transport Layer Security, and will provide an x509 certificate for authentication.

The default value is NONE .

Parameters:

clusterEndpointEncryptionType - The encryption type of the cluster's endpoint. Available values are:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clusterendpointencryptiontype

clusterName

@Stability(Stable)
public CfnCluster.Builder clusterName(String clusterName)

The name of the DAX cluster.

Parameters:

clusterName - The name of the DAX cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername

description

@Stability(Stable)
public CfnCluster.Builder description(String description)

The description of the cluster.

Parameters:

description - The description of the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-description

notificationTopicArn

@Stability(Stable)
public CfnCluster.Builder notificationTopicArn(String notificationTopicArn)

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-notificationtopicarn

parameterGroupName

@Stability(Stable)
public CfnCluster.Builder parameterGroupName(String parameterGroupName)

The parameter group to be associated with the DAX cluster.

Parameters:

parameterGroupName - The parameter group to be associated with the DAX cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-parametergroupname

preferredMaintenanceWindow

@Stability(Stable)
public CfnCluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

A range of time when maintenance of DAX cluster software will be performed.

For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

Parameters:

preferredMaintenanceWindow - A range of time when maintenance of DAX cluster software will be performed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-preferredmaintenancewindow

securityGroupIds

@Stability(Stable)
public CfnCluster.Builder securityGroupIds(List<String> securityGroupIds)

A list of security group IDs to be assigned to each node in the DAX cluster.

(Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

Parameters:

securityGroupIds - A list of security group IDs to be assigned to each node in the DAX cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-securitygroupids

sseSpecification

@Stability(Stable)
public CfnCluster.Builder sseSpecification(IResolvable sseSpecification)

Represents the settings used to enable server-side encryption on the cluster.

Parameters:

sseSpecification - Represents the settings used to enable server-side encryption on the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-ssespecification

sseSpecification

@Stability(Stable)
public CfnCluster.Builder sseSpecification(CfnCluster.SSESpecificationProperty sseSpecification)

Represents the settings used to enable server-side encryption on the cluster.

Parameters:

sseSpecification - Represents the settings used to enable server-side encryption on the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-ssespecification

subnetGroupName

@Stability(Stable)
public CfnCluster.Builder subnetGroupName(String subnetGroupName)

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

Parameters:

subnetGroupName - The name of the subnet group to be used for the replication group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname

tags

@Stability(Stable)
public CfnCluster.Builder tags(Object tags)

A set of tags to associate with the DAX cluster.

Parameters:

tags - A set of tags to associate with the DAX cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-tags

build

@Stability(Stable)
public CfnCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCluster>

Returns:

a newly built instance of CfnCluster.