Package software.amazon.awscdk.services.dax

Class CfnClusterProps.Builder

java.lang.Object
software.amazon.awscdk.services.dax.CfnClusterProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterProps>
Enclosing interface:
CfnClusterProps
@Stability(Stable) public static final class CfnClusterProps.Builder extends Object implements software.amazon.jsii.Builder<CfnClusterProps>
A builder for CfnClusterProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • iamRoleArn

      @Stability(Stable) public CfnClusterProps.Builder iamRoleArn(String iamRoleArn)
      Sets the value of CfnClusterProps.getIamRoleArn()
      Parameters:
      iamRoleArn - A valid Amazon Resource Name (ARN) that identifies an IAM role. This parameter is required. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
      Returns:
      this

    • nodeType

      @Stability(Stable) public CfnClusterProps.Builder nodeType(String nodeType)
      Sets the value of CfnClusterProps.getNodeType()
      Parameters:
      nodeType - The node type for the nodes in the cluster. This parameter is required. (All nodes in a DAX cluster are of the same type.)
      Returns:
      this

    • replicationFactor

      @Stability(Stable) public CfnClusterProps.Builder replicationFactor(Number replicationFactor)
      Sets the value of CfnClusterProps.getReplicationFactor()
      Parameters:
      replicationFactor - The number of nodes in the DAX cluster. This parameter is required. 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.

      Returns:
      this

    • availabilityZones

      @Stability(Stable) public CfnClusterProps.Builder availabilityZones(List<String> availabilityZones)
      Sets the value of CfnClusterProps.getAvailabilityZones()
      Parameters:
      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.
      Returns:
      this

    • clusterEndpointEncryptionType

      @Stability(Stable) public CfnClusterProps.Builder clusterEndpointEncryptionType(String clusterEndpointEncryptionType)
      Sets the value of CfnClusterProps.getClusterEndpointEncryptionType()
      Parameters:
      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 .

      Returns:
      this

    • clusterName

      @Stability(Stable) public CfnClusterProps.Builder clusterName(String clusterName)
      Sets the value of CfnClusterProps.getClusterName()
      Parameters:
      clusterName - The name of the DAX cluster.
      Returns:
      this

    • description

      @Stability(Stable) public CfnClusterProps.Builder description(String description)
      Sets the value of CfnClusterProps.getDescription()
      Parameters:
      description - The description of the cluster.
      Returns:
      this

    • notificationTopicArn

      @Stability(Stable) public CfnClusterProps.Builder notificationTopicArn(String notificationTopicArn)
      Sets the value of CfnClusterProps.getNotificationTopicArn()
      Parameters:
      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.

      Returns:
      this

    • parameterGroupName

      @Stability(Stable) public CfnClusterProps.Builder parameterGroupName(String parameterGroupName)
      Sets the value of CfnClusterProps.getParameterGroupName()
      Parameters:
      parameterGroupName - The parameter group to be associated with the DAX cluster.
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Sets the value of CfnClusterProps.getPreferredMaintenanceWindow()
      Parameters:
      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.
      Returns:
      this

    • securityGroupIds

      @Stability(Stable) public CfnClusterProps.Builder securityGroupIds(List<String> securityGroupIds)
      Sets the value of CfnClusterProps.getSecurityGroupIds()
      Parameters:
      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.

      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnClusterProps.Builder sseSpecification(IResolvable sseSpecification)
      Sets the value of CfnClusterProps.getSseSpecification()
      Parameters:
      sseSpecification - Represents the settings used to enable server-side encryption on the cluster.
      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnClusterProps.Builder sseSpecification(CfnCluster.SSESpecificationProperty sseSpecification)
      Sets the value of CfnClusterProps.getSseSpecification()
      Parameters:
      sseSpecification - Represents the settings used to enable server-side encryption on the cluster.
      Returns:
      this

    • subnetGroupName

      @Stability(Stable) public CfnClusterProps.Builder subnetGroupName(String subnetGroupName)
      Sets the value of CfnClusterProps.getSubnetGroupName()
      Parameters:
      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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnClusterProps.Builder tags(Object tags)
      Sets the value of CfnClusterProps.getTags()
      Parameters:
      tags - A set of tags to associate with the DAX cluster.
      Returns:
      this

    • build

      @Stability(Stable) public CfnClusterProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnClusterProps>
      Returns:
      a new instance of CfnClusterProps
      Throws:
      NullPointerException - if any required attribute was not provided