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:

  • Method Details

    • 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

    • engine

      public final String engine()

      The name of the engine used by the cluster configuration.

      Returns:
      The name of the engine used by the cluster configuration.

    • engineVersion

      public final String engineVersion()

      The Redis OSS engine version used by the cluster

      Returns:
      The Redis OSS 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 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<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

    • multiRegionParameterGroupName

      public final String multiRegionParameterGroupName()

      The name of the multi-Region parameter group associated with the cluster configuration.

      Returns:
      The name of the multi-Region parameter group associated with the cluster configuration.

    • multiRegionClusterName

      public final String multiRegionClusterName()

      The name for the multi-Region cluster associated with the cluster configuration.

      Returns:
      The name for the multi-Region cluster associated with the cluster configuration.

    • toBuilder

      public ClusterConfiguration.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<ClusterConfiguration.Builder,ClusterConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ClusterConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.