JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.dax.model

Class Cluster

    • Constructor Detail

      • Cluster

        public Cluster()
    • Method Detail

      • setClusterName

        public void setClusterName(String clusterName)

        The name of the DAX cluster.

        Parameters:
        clusterName - The name of the DAX cluster.
      • getClusterName

        public String getClusterName()

        The name of the DAX cluster.

        Returns:
        The name of the DAX cluster.
      • withClusterName

        public Cluster withClusterName(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.
      • setDescription

        public void setDescription(String description)

        The description of the cluster.

        Parameters:
        description - The description of the cluster.
      • getDescription

        public String getDescription()

        The description of the cluster.

        Returns:
        The description of the cluster.
      • withDescription

        public Cluster withDescription(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.
      • setClusterArn

        public void setClusterArn(String clusterArn)

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

        Parameters:
        clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.
      • getClusterArn

        public String getClusterArn()

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

        Returns:
        The Amazon Resource Name (ARN) that uniquely identifies the cluster.
      • withClusterArn

        public Cluster withClusterArn(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.
      • setTotalNodes

        public void setTotalNodes(Integer totalNodes)

        The total number of nodes in the cluster.

        Parameters:
        totalNodes - The total number of nodes in the cluster.
      • getTotalNodes

        public Integer getTotalNodes()

        The total number of nodes in the cluster.

        Returns:
        The total number of nodes in the cluster.
      • withTotalNodes

        public Cluster withTotalNodes(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.
      • setActiveNodes

        public void setActiveNodes(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).
      • getActiveNodes

        public Integer getActiveNodes()

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

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

        public Cluster withActiveNodes(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.
      • setNodeType

        public void setNodeType(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.)
      • getNodeType

        public String getNodeType()

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

        Returns:
        The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
      • withNodeType

        public Cluster withNodeType(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.
      • setStatus

        public void setStatus(String status)

        The current status of the cluster.

        Parameters:
        status - The current status of the cluster.
      • getStatus

        public String getStatus()

        The current status of the cluster.

        Returns:
        The current status of the cluster.
      • withStatus

        public Cluster withStatus(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.
      • setClusterDiscoveryEndpoint

        public void setClusterDiscoveryEndpoint(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.
      • getClusterDiscoveryEndpoint

        public Endpoint getClusterDiscoveryEndpoint()

        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:
        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.
      • withClusterDiscoveryEndpoint

        public Cluster withClusterDiscoveryEndpoint(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.
      • getNodeIdsToRemove

        public List<String> getNodeIdsToRemove()

        A list of nodes to be removed from the cluster.

        Returns:
        A list of nodes to be removed from the cluster.
      • setNodeIdsToRemove

        public void setNodeIdsToRemove(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.
      • withNodeIdsToRemove

        public Cluster withNodeIdsToRemove(String... nodeIdsToRemove)

        A list of nodes to be removed from the cluster.

        NOTE: This method appends the values to the existing list (if any). Use setNodeIdsToRemove(java.util.Collection) or withNodeIdsToRemove(java.util.Collection) if you want to override the existing values.

        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.
      • withNodeIdsToRemove

        public Cluster withNodeIdsToRemove(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.
      • getNodes

        public List<Node> getNodes()

        A list of nodes that are currently in the cluster.

        Returns:
        A list of nodes that are currently in the cluster.
      • setNodes

        public void setNodes(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.
      • withNodes

        public Cluster withNodes(Node... nodes)

        A list of nodes that are currently in the cluster.

        NOTE: This method appends the values to the existing list (if any). Use setNodes(java.util.Collection) or withNodes(java.util.Collection) if you want to override the existing values.

        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.
      • withNodes

        public Cluster withNodes(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.
      • setPreferredMaintenanceWindow

        public void setPreferredMaintenanceWindow(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.
      • getPreferredMaintenanceWindow

        public String getPreferredMaintenanceWindow()

        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:
        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.
      • withPreferredMaintenanceWindow

        public Cluster withPreferredMaintenanceWindow(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.
      • setNotificationConfiguration

        public void setNotificationConfiguration(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).
      • getNotificationConfiguration

        public NotificationConfiguration getNotificationConfiguration()

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

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

        public Cluster withNotificationConfiguration(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.
      • setSubnetGroup

        public void setSubnetGroup(String subnetGroup)

        The subnet group where the DAX cluster is running.

        Parameters:
        subnetGroup - The subnet group where the DAX cluster is running.
      • getSubnetGroup

        public String getSubnetGroup()

        The subnet group where the DAX cluster is running.

        Returns:
        The subnet group where the DAX cluster is running.
      • withSubnetGroup

        public Cluster withSubnetGroup(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.
      • getSecurityGroups

        public List<SecurityGroupMembership> getSecurityGroups()

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

        Returns:
        A list of security groups, and the status of each, for the nodes in the cluster.
      • setSecurityGroups

        public void setSecurityGroups(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.
      • withSecurityGroups

        public Cluster withSecurityGroups(SecurityGroupMembership... securityGroups)

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

        NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

        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.
      • withSecurityGroups

        public Cluster withSecurityGroups(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.
      • setIamRoleArn

        public void setIamRoleArn(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.
      • getIamRoleArn

        public String getIamRoleArn()

        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:
        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.
      • withIamRoleArn

        public Cluster withIamRoleArn(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.
      • setParameterGroup

        public void setParameterGroup(ParameterGroupStatus parameterGroup)

        The parameter group being used by nodes in the cluster.

        Parameters:
        parameterGroup - The parameter group being used by nodes in the cluster.
      • getParameterGroup

        public ParameterGroupStatus getParameterGroup()

        The parameter group being used by nodes in the cluster.

        Returns:
        The parameter group being used by nodes in the cluster.
      • withParameterGroup

        public Cluster withParameterGroup(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.
      • setSSEDescription

        public void setSSEDescription(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.
      • getSSEDescription

        public SSEDescription getSSEDescription()

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

        Returns:
        The description of the server-side encryption status on the specified DAX cluster.
      • withSSEDescription

        public Cluster withSSEDescription(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.
      • setClusterEndpointEncryptionType

        public void setClusterEndpointEncryptionType(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

        See Also:
        ClusterEndpointEncryptionType
      • getClusterEndpointEncryptionType

        public String getClusterEndpointEncryptionType()

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

        • NONE for no encryption

          TLS for Transport Layer Security

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

        • NONE for no encryption

          TLS for Transport Layer Security

        See Also:
        ClusterEndpointEncryptionType
      • withClusterEndpointEncryptionType

        public Cluster withClusterEndpointEncryptionType(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
      • withClusterEndpointEncryptionType

        public Cluster withClusterEndpointEncryptionType(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:
        ClusterEndpointEncryptionType
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /