Package software.amazon.awssdk.services.dax.model

Interface CreateClusterRequest.Builder

    • Method Detail

      • clusterName

        CreateClusterRequest.Builder clusterName​(String clusterName)

        The cluster identifier. This parameter is stored as a lowercase string.

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

        Parameters:
        clusterName - The cluster identifier. This parameter is stored as a lowercase string.

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeType

        CreateClusterRequest.Builder nodeType​(String nodeType)

        The compute and memory capacity of the nodes in the cluster.

        Parameters:
        nodeType - The compute and memory capacity of the nodes in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateClusterRequest.Builder description​(String description)

        A description of the cluster.

        Parameters:
        description - A description of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationFactor

        CreateClusterRequest.Builder replicationFactor​(Integer 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. 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:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        CreateClusterRequest.Builder availabilityZones​(Collection<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. 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:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        CreateClusterRequest.Builder availabilityZones​(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. 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:
        Returns a reference to this object so that method calls can be chained together.

      • subnetGroupName

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

        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:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        CreateClusterRequest.Builder securityGroupIds​(Collection<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. (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:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        CreateClusterRequest.Builder securityGroupIds​(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. (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:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        CreateClusterRequest.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationTopicArn

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamRoleArn

        CreateClusterRequest.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. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameterGroupName

        CreateClusterRequest.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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Collection<Tag> tags)

        A set of tags to associate with the DAX cluster.

        Parameters:
        tags - A set of tags to associate with the DAX cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Tag... tags)

        A set of tags to associate with the DAX cluster.

        Parameters:
        tags - A set of tags to associate with the DAX cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A set of tags to associate with the DAX cluster.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • sseSpecification

        CreateClusterRequest.Builder sseSpecification​(SSESpecification 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterEndpointEncryptionType

        CreateClusterRequest.Builder clusterEndpointEncryptionType​(String clusterEndpointEncryptionType)

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Parameters:
        clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterEndpointEncryptionType, ClusterEndpointEncryptionType

      • clusterEndpointEncryptionType

        CreateClusterRequest.Builder clusterEndpointEncryptionType​(ClusterEndpointEncryptionType clusterEndpointEncryptionType)

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Parameters:
        clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterEndpointEncryptionType, ClusterEndpointEncryptionType