java.lang.Object
- software.amazon.awssdk.services.memorydb.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 cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Cluster.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`aclName()`	The name of the Access Control List associated with this cluster.
`String`	`arn()`	The Amazon Resource Name (ARN) of the cluster.
`Boolean`	`autoMinorVersionUpgrade()`	When set to true, the cluster will automatically receive minor engine version upgrades after launch.
`AZStatus`	`availabilityMode()`	Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
`String`	`availabilityModeAsString()`	Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
`static Cluster.Builder`	`builder()`
`Endpoint`	`clusterEndpoint()`	The cluster's configuration endpoint
`DataTieringStatus`	`dataTiering()`	Enables data tiering.
`String`	`dataTieringAsString()`	Enables data tiering.
`String`	`description()`	A description of the cluster
`String`	`engine()`	The Redis OSS or Valkey engine used by the cluster.
`String`	`enginePatchVersion()`	The engine patch version used by the cluster
`String`	`engineVersion()`	The Redis engine version used by the cluster
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()`	For responses, this returns true if the service returned a value for the SecurityGroups property.
`boolean`	`hasShards()`	For responses, this returns true if the service returned a value for the Shards property.
`String`	`kmsKeyId()`	The ID of the KMS key used to encrypt the cluster
`String`	`maintenanceWindow()`	Specifies the weekly time range during which maintenance on the cluster is performed.
`String`	`name()`	The user-supplied name of the cluster.
`String`	`nodeType()`	The cluster's node type
`Integer`	`numberOfShards()`	The number of shards in the cluster
`String`	`parameterGroupName()`	The name of the parameter group used by the cluster
`String`	`parameterGroupStatus()`	The status of the parameter group used by the cluster, for example 'active' or 'applying'.
`ClusterPendingUpdates`	`pendingUpdates()`	A group of settings that are currently being applied.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<SecurityGroupMembership>`	`securityGroups()`	A list of security groups used by the cluster
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`List<Shard>`	`shards()`	A list of shards that are members of the cluster.
`Integer`	`snapshotRetentionLimit()`	The number of days for which MemoryDB retains automatic snapshots before deleting them.
`String`	`snapshotWindow()`	The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
`String`	`snsTopicArn()`	The Amazon Resource Name (ARN) of the SNS notification topic
`String`	`snsTopicStatus()`	The SNS topic must be in Active status to receive notifications
`String`	`status()`	The status of the cluster.
`String`	`subnetGroupName()`	The name of the subnet group used by the cluster
`Boolean`	`tlsEnabled()`	A flag to indicate if In-transit encryption is enabled
`Cluster.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - name
```
public final String name()
```
    The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
    
    Returns:
    
    The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
  - description
```
public final String description()
```
    A description of the cluster
    
    Returns:
    
    A description of the cluster
  - status
```
public final String status()
```
    The status of the cluster. For example, Available, Updating, Creating.
    
    Returns:
    
    The status of the cluster. For example, Available, Updating, Creating.
  - pendingUpdates
```
public final ClusterPendingUpdates pendingUpdates()
```
    A group of settings that are currently being applied.
    
    Returns:
    
    A group of settings that are currently being applied.
  - numberOfShards
```
public final Integer numberOfShards()
```
    The number of shards in the cluster
    
    Returns:
    
    The number of shards in the cluster
  - hasShards
```
public final boolean hasShards()
```
    For responses, this returns true if the service returned a value for the Shards 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.
  - shards
```
public final List<Shard> shards()
```
    A list of shards that are members of 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 hasShards() method.
    
    Returns:
    
    A list of shards that are members of the cluster.
  - availabilityMode
```
public final AZStatus availabilityMode()
```
    Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
    
    If the service returns an enum value that is not available in the current SDK version, availabilityMode will return AZStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availabilityModeAsString().
    
    Returns:
    
    Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
    
    See Also:
    
    AZStatus
  - availabilityModeAsString
```
public final String availabilityModeAsString()
```
    Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
    
    If the service returns an enum value that is not available in the current SDK version, availabilityMode will return AZStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from availabilityModeAsString().
    
    Returns:
    
    Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
    
    See Also:
    
    AZStatus
  - clusterEndpoint
```
public final Endpoint clusterEndpoint()
```
    The cluster's configuration endpoint
    
    Returns:
    
    The cluster's configuration endpoint
  - nodeType
```
public final String nodeType()
```
    The cluster's node type
    
    Returns:
    
    The cluster's node type
  - engine
```
public final String engine()
```
    The Redis OSS or Valkey engine used by the cluster.
    
    Returns:
    
    The Redis OSS or Valkey engine used by the cluster.
  - engineVersion
```
public final String engineVersion()
```
    The Redis engine version used by the cluster
    
    Returns:
    
    The Redis engine version used by the cluster
  - enginePatchVersion
```
public final String enginePatchVersion()
```
    The engine patch version used by the cluster
    
    Returns:
    
    The engine patch version used by the cluster
  - parameterGroupName
```
public final String parameterGroupName()
```
    The name of the parameter group used by the cluster
    
    Returns:
    
    The name of the parameter group used by the cluster
  - parameterGroupStatus
```
public final String parameterGroupStatus()
```
    The status of the parameter group used by the cluster, for example 'active' or 'applying'.
    
    Returns:
    
    The status of the parameter group used by the cluster, for example 'active' or 'applying'.
  - 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 used by 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 used by the cluster
  - subnetGroupName
```
public final String subnetGroupName()
```
    The name of the subnet group used by the cluster
    
    Returns:
    
    The name of the subnet group used by the cluster
  - tlsEnabled
```
public final Boolean tlsEnabled()
```
    A flag to indicate if In-transit encryption is enabled
    
    Returns:
    
    A flag to indicate if In-transit encryption is enabled
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the KMS key used to encrypt the cluster
    
    Returns:
    
    The ID of the KMS key used to encrypt the cluster
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the cluster.
  - snsTopicArn
```
public final String snsTopicArn()
```
    The Amazon Resource Name (ARN) of the SNS notification topic
    
    Returns:
    
    The Amazon Resource Name (ARN) of the SNS notification topic
  - snsTopicStatus
```
public final String snsTopicStatus()
```
    The SNS topic must be in Active status to receive notifications
    
    Returns:
    
    The SNS topic must be in Active status to receive notifications
  - snapshotRetentionLimit
```
public final Integer snapshotRetentionLimit()
```
    The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
    
    Returns:
    
    The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
  - maintenanceWindow
```
public final String maintenanceWindow()
```
    Specifies the weekly time range during which maintenance on the 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.
    
    Returns:
    
    Specifies the weekly time range during which maintenance on the 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.
  - snapshotWindow
```
public final String snapshotWindow()
```
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
    
    Returns:
    
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
  - aclName
```
public final String aclName()
```
    The name of the Access Control List associated with this cluster.
    
    Returns:
    
    The name of the Access Control List associated with this cluster.
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    When set to true, the cluster will automatically receive minor engine version upgrades after launch.
    
    Returns:
    
    When set to true, the cluster will automatically receive minor engine version upgrades after launch.
  - dataTiering
```
public final DataTieringStatus dataTiering()
```
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
    
    If the service returns an enum value that is not available in the current SDK version, dataTiering will return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTieringAsString().
    
    Returns:
    
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
    
    See Also:
    
    DataTieringStatus
  - dataTieringAsString
```
public final String dataTieringAsString()
```
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
    
    If the service returns an enum value that is not available in the current SDK version, dataTiering will return DataTieringStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTieringAsString().
    
    Returns:
    
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
    
    See Also:
    
    DataTieringStatus
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField 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

name

description

status

pendingUpdates

numberOfShards

hasShards

shards

availabilityMode

availabilityModeAsString

clusterEndpoint

nodeType

engine

engineVersion

enginePatchVersion

parameterGroupName

parameterGroupStatus

hasSecurityGroups

securityGroups

subnetGroupName

tlsEnabled

kmsKeyId

arn

snsTopicArn

snsTopicStatus

snapshotRetentionLimit

maintenanceWindow

snapshotWindow

aclName

autoMinorVersionUpgrade

dataTiering

dataTieringAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField