Package software.amazon.awssdk.services.elasticache.model

Class NodeGroupConfiguration

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

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

See Also:

  • Method Details

    • nodeGroupId

      public final String nodeGroupId()

      Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

      Returns:
      Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

    • slots

      public final String slots()

      A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

      Example: "0-3999"

      Returns:
      A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

      Example: "0-3999"

    • replicaCount

      public final Integer replicaCount()

      The number of read replica nodes in this node group (shard).

      Returns:
      The number of read replica nodes in this node group (shard).

    • primaryAvailabilityZone

      public final String primaryAvailabilityZone()

      The Availability Zone where the primary node of this node group (shard) is launched.

      Returns:
      The Availability Zone where the primary node of this node group (shard) is launched.

    • hasReplicaAvailabilityZones

      public final boolean hasReplicaAvailabilityZones()
      For responses, this returns true if the service returned a value for the ReplicaAvailabilityZones 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.

    • replicaAvailabilityZones

      public final List<String> replicaAvailabilityZones()

      A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

      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 hasReplicaAvailabilityZones() method.

      Returns:
      A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

    • primaryOutpostArn

      public final String primaryOutpostArn()

      The outpost ARN of the primary node.

      Returns:
      The outpost ARN of the primary node.

    • hasReplicaOutpostArns

      public final boolean hasReplicaOutpostArns()
      For responses, this returns true if the service returned a value for the ReplicaOutpostArns 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.

    • replicaOutpostArns

      public final List<String> replicaOutpostArns()

      The outpost ARN of the node replicas.

      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 hasReplicaOutpostArns() method.

      Returns:
      The outpost ARN of the node replicas.

    • toBuilder

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

    • builder

      public static NodeGroupConfiguration.Builder builder()

    • serializableBuilderClass

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