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

Interface Cluster.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo
Enclosing class:
Cluster
public static interface Cluster.Builder extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

  • Method Details

    • clusterName

      Cluster.Builder clusterName(String clusterName)

      The name of the DAX cluster.

      Parameters:
      clusterName - The name of the DAX cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Cluster.Builder description(String description)

      The description of the cluster.

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

    • clusterArn

      Cluster.Builder clusterArn(String clusterArn)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

      Parameters:
      clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalNodes

      Cluster.Builder totalNodes(Integer totalNodes)

      The total number of nodes in the cluster.

      Parameters:
      totalNodes - The total number of nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeNodes

      Cluster.Builder activeNodes(Integer activeNodes)

      The number of nodes in the cluster that are active (i.e., capable of serving requests).

      Parameters:
      activeNodes - The number of nodes in the cluster that are active (i.e., capable of serving requests).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeType

      Cluster.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. (All nodes in a DAX cluster are of the same type.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Cluster.Builder status(String status)

      The current status of the cluster.

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

    • clusterDiscoveryEndpoint

      Cluster.Builder clusterDiscoveryEndpoint(Endpoint clusterDiscoveryEndpoint)

      The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

      Parameters:
      clusterDiscoveryEndpoint - The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterDiscoveryEndpoint

      default Cluster.Builder clusterDiscoveryEndpoint(Consumer<Endpoint.Builder> clusterDiscoveryEndpoint)

      The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterDiscoveryEndpoint(Endpoint).

      Parameters:
      clusterDiscoveryEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeIdsToRemove

      Cluster.Builder nodeIdsToRemove(Collection<String> nodeIdsToRemove)

      A list of nodes to be removed from the cluster.

      Parameters:
      nodeIdsToRemove - A list of nodes to be removed from the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeIdsToRemove

      Cluster.Builder nodeIdsToRemove(String... nodeIdsToRemove)

      A list of nodes to be removed from the cluster.

      Parameters:
      nodeIdsToRemove - A list of nodes to be removed from the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodes

      Cluster.Builder nodes(Collection<Node> nodes)

      A list of nodes that are currently in the cluster.

      Parameters:
      nodes - A list of nodes that are currently in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodes

      Cluster.Builder nodes(Node... nodes)

      A list of nodes that are currently in the cluster.

      Parameters:
      nodes - A list of nodes that are currently in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodes

      Cluster.Builder nodes(Consumer<Node.Builder>... nodes)

      A list of nodes that are currently in the cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodes(List<Node>).

      Parameters:
      nodes - a consumer that will call methods on Node.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • preferredMaintenanceWindow

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

    • notificationConfiguration

      Cluster.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration)

      Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

      Parameters:
      notificationConfiguration - Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationConfiguration

      default Cluster.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)

      Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationConfiguration(NotificationConfiguration).

      Parameters:
      notificationConfiguration - a consumer that will call methods on NotificationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subnetGroup

      Cluster.Builder subnetGroup(String subnetGroup)

      The subnet group where the DAX cluster is running.

      Parameters:
      subnetGroup - The subnet group where the DAX cluster is running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      Cluster.Builder securityGroups(Collection<SecurityGroupMembership> securityGroups)

      A list of security groups, and the status of each, for the nodes in the cluster.

      Parameters:
      securityGroups - A list of security groups, and the status of each, for the nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      Cluster.Builder securityGroups(SecurityGroupMembership... securityGroups)

      A list of security groups, and the status of each, for the nodes in the cluster.

      Parameters:
      securityGroups - A list of security groups, and the status of each, for the nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      Cluster.Builder securityGroups(Consumer<SecurityGroupMembership.Builder>... securityGroups)

      A list of security groups, and the status of each, for the nodes in the cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to securityGroups(List<SecurityGroupMembership>).

      Parameters:
      securityGroups - a consumer that will call methods on SecurityGroupMembership.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iamRoleArn

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

    • parameterGroup

      Cluster.Builder parameterGroup(ParameterGroupStatus parameterGroup)

      The parameter group being used by nodes in the cluster.

      Parameters:
      parameterGroup - The parameter group being used by nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterGroup

      default Cluster.Builder parameterGroup(Consumer<ParameterGroupStatus.Builder> parameterGroup)

      The parameter group being used by nodes in the cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterGroup(ParameterGroupStatus).

      Parameters:
      parameterGroup - a consumer that will call methods on ParameterGroupStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sseDescription

      Cluster.Builder sseDescription(SSEDescription sseDescription)

      The description of the server-side encryption status on the specified DAX cluster.

      Parameters:
      sseDescription - The description of the server-side encryption status on the specified DAX cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseDescription

      default Cluster.Builder sseDescription(Consumer<SSEDescription.Builder> sseDescription)

      The description of the server-side encryption status on the specified DAX cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sseDescription(SSEDescription).

      Parameters:
      sseDescription - a consumer that will call methods on SSEDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterEndpointEncryptionType

      Cluster.Builder clusterEndpointEncryptionType(String clusterEndpointEncryptionType)

      The type of encryption supported by the cluster's endpoint. Values are:

      • NONE for no encryption

        TLS for Transport Layer Security

      Parameters:
      clusterEndpointEncryptionType - The type of encryption supported by the cluster's endpoint. 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

      Cluster.Builder clusterEndpointEncryptionType(ClusterEndpointEncryptionType clusterEndpointEncryptionType)

      The type of encryption supported by the cluster's endpoint. Values are:

      • NONE for no encryption

        TLS for Transport Layer Security

      Parameters:
      clusterEndpointEncryptionType - The type of encryption supported by the cluster's endpoint. 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: