Class Cluster

java.lang.Object
software.amazon.awssdk.services.dax.model.Cluster
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>
@Generated("software.amazon.awssdk:codegen") public final class Cluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>

Contains all of the attributes of a specific DAX cluster.

See Also:

  • Method Details

    • clusterName

      public final String clusterName()

      The name of the DAX cluster.

      Returns:
      The name of the DAX cluster.

    • description

      public final String description()

      The description of the cluster.

      Returns:
      The description of the cluster.

    • clusterArn

      public final String clusterArn()

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

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

    • totalNodes

      public final Integer totalNodes()

      The total number of nodes in the cluster.

      Returns:
      The total number of nodes in the cluster.

    • activeNodes

      public final Integer activeNodes()

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

    • nodeType

      public final String nodeType()

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

    • status

      public final String status()

      The current status of the cluster.

      Returns:
      The current status of the cluster.

    • clusterDiscoveryEndpoint

      public final 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.

      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.

    • hasNodeIdsToRemove

      public final boolean hasNodeIdsToRemove()
      For responses, this returns true if the service returned a value for the NodeIdsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • nodeIdsToRemove

      public final List<String> nodeIdsToRemove()

      A list of nodes to be removed from the cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeIdsToRemove() method.

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

    • hasNodes

      public final boolean hasNodes()
      For responses, this returns true if the service returned a value for the Nodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • nodes

      public final List<Node> nodes()

      A list of nodes that are currently in the cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodes() method.

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

    • preferredMaintenanceWindow

      public final 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.

      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.

    • notificationConfiguration

      public final 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).

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

    • subnetGroup

      public final String subnetGroup()

      The subnet group where the DAX cluster is running.

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

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroups

      public final List<SecurityGroupMembership> securityGroups()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

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

    • iamRoleArn

      public final 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.

      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.

    • parameterGroup

      public final ParameterGroupStatus parameterGroup()

      The parameter group being used by nodes in the cluster.

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

    • sseDescription

      public final SSEDescription sseDescription()

      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.

    • clusterEndpointEncryptionType

      public final ClusterEndpointEncryptionType clusterEndpointEncryptionType()

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

      • NONE for no encryption

        TLS for Transport Layer Security

      If the service returns an enum value that is not available in the current SDK version, clusterEndpointEncryptionType will return ClusterEndpointEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterEndpointEncryptionTypeAsString().

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

      • NONE for no encryption

        TLS for Transport Layer Security

      See Also:

    • clusterEndpointEncryptionTypeAsString

      public final String clusterEndpointEncryptionTypeAsString()

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

      • NONE for no encryption

        TLS for Transport Layer Security

      If the service returns an enum value that is not available in the current SDK version, clusterEndpointEncryptionType will return ClusterEndpointEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterEndpointEncryptionTypeAsString().

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

      • NONE for no encryption

        TLS for Transport Layer Security

      See Also:

    • toBuilder

      public Cluster.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
      Returns:
      a builder for type T

    • builder

      public static Cluster.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Cluster.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.