Class ClusterConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.memorydb.model.ClusterConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ClusterConfiguration.Builder,ClusterConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ClusterConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterConfiguration.Builder,ClusterConfiguration>
A list of cluster configuration options.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceClusterConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClusterConfiguration.Builderbuilder()Stringdescription()The description of the cluster configurationStringengineVersion()The Redis engine version used by the clusterbooleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasShards()For responses, this returns true if the service returned a value for the Shards property.StringmaintenanceWindow()The specified maintenance window for the clusterStringname()The name of the clusterStringnodeType()The node type used for the clusterIntegernumShards()The number of shards in the clusterStringparameterGroupName()The name of parameter group used by the clusterIntegerport()The port used by the clusterList<SdkField<?>>sdkFields()static Class<? extends ClusterConfiguration.Builder>serializableBuilderClass()List<ShardDetail>shards()The list of shards in the clusterIntegersnapshotRetentionLimit()The snapshot retention limit set by the clusterStringsnapshotWindow()The snapshot window set by the clusterStringsubnetGroupName()The name of the subnet group used by the clusterClusterConfiguration.BuildertoBuilder()StringtopicArn()The Amazon Resource Name (ARN) of the SNS notification topic for the clusterStringtoString()Returns a string representation of this object.StringvpcId()The ID of the VPC the cluster belongs to-
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 name of the cluster
- Returns:
- The name of the cluster
-
description
public final String description()
The description of the cluster configuration
- Returns:
- The description of the cluster configuration
-
nodeType
public final String nodeType()
The node type used for the cluster
- Returns:
- The node type used for the cluster
-
engineVersion
public final String engineVersion()
The Redis engine version used by the cluster
- Returns:
- The Redis engine version used by the cluster
-
maintenanceWindow
public final String maintenanceWindow()
The specified maintenance window for the cluster
- Returns:
- The specified maintenance window for the cluster
-
topicArn
public final String topicArn()
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
- Returns:
- The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
-
port
public final Integer port()
The port used by the cluster
- Returns:
- The port used by the cluster
-
parameterGroupName
public final String parameterGroupName()
The name of parameter group used by the cluster
- Returns:
- The name of parameter group 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
-
vpcId
public final String vpcId()
The ID of the VPC the cluster belongs to
- Returns:
- The ID of the VPC the cluster belongs to
-
snapshotRetentionLimit
public final Integer snapshotRetentionLimit()
The snapshot retention limit set by the cluster
- Returns:
- The snapshot retention limit set by the cluster
-
snapshotWindow
public final String snapshotWindow()
The snapshot window set by the cluster
- Returns:
- The snapshot window set by the cluster
-
numShards
public final Integer numShards()
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 theisEmpty()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<ShardDetail> shards()
The list of shards 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
hasShards()method.- Returns:
- The list of shards in the cluster
-
toBuilder
public ClusterConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ClusterConfiguration.Builder,ClusterConfiguration>
-
builder
public static ClusterConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends ClusterConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-