Cluster (AWS Java SDK :: Services :: Amazon DynamoDB Accelerator (DAX) 2.21.2 API)

java.lang.Object
- software.amazon.awssdk.services.dax.model.Cluster

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Cluster.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Cluster.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`activeNodes()` The number of nodes in the cluster that are active (i.e., capable of serving requests).
`static Cluster.Builder`	`builder()`
`String`	`clusterArn()` The Amazon Resource Name (ARN) that uniquely identifies the cluster.
`Endpoint`	`clusterDiscoveryEndpoint()` The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL.
`ClusterEndpointEncryptionType`	`clusterEndpointEncryptionType()` The type of encryption supported by the cluster's endpoint.
`String`	`clusterEndpointEncryptionTypeAsString()` The type of encryption supported by the cluster's endpoint.
`String`	`clusterName()` The name of the DAX cluster.
`String`	`description()` The description of the cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasNodeIdsToRemove()` For responses, this returns true if the service returned a value for the NodeIdsToRemove property.
`boolean`	`hasNodes()` For responses, this returns true if the service returned a value for the Nodes property.
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`String`	`iamRoleArn()` A valid Amazon Resource Name (ARN) that identifies an IAM role.
`List<String>`	`nodeIdsToRemove()` A list of nodes to be removed from the cluster.
`List<Node>`	`nodes()` A list of nodes that are currently in the cluster.
`String`	`nodeType()` The node type for the nodes in the cluster.
`NotificationConfiguration`	`notificationConfiguration()` Describes a notification topic and its status.
`ParameterGroupStatus`	`parameterGroup()` The parameter group being used by nodes in the cluster.
`String`	`preferredMaintenanceWindow()` A range of time when maintenance of DAX cluster software will be performed.
`List<SdkField<?>>`	`sdkFields()`
`List<SecurityGroupMembership>`	`securityGroups()` A list of security groups, and the status of each, for the nodes in the cluster.
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`SSEDescription`	`sseDescription()` The description of the server-side encryption status on the specified DAX cluster.
`String`	`status()` The current status of the cluster.
`String`	`subnetGroup()` The subnet group where the DAX cluster is running.
`Cluster.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`totalNodes()` The total number of nodes in the cluster.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ClusterEndpointEncryptionType
  - 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:
    
    ClusterEndpointEncryptionType
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterName

description

clusterArn

totalNodes

activeNodes

nodeType

status

clusterDiscoveryEndpoint

hasNodeIdsToRemove

nodeIdsToRemove

hasNodes

nodes

preferredMaintenanceWindow

notificationConfiguration

subnetGroup

hasSecurityGroups

securityGroups

iamRoleArn

parameterGroup

sseDescription

clusterEndpointEncryptionType

clusterEndpointEncryptionTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields