Class PendingModifiedValues

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

A group of settings that are applied to the cluster in the future, or that are currently being applied.

See Also:

  • Method Details

    • numCacheNodes

      public final Integer numCacheNodes()

      The new number of cache nodes for the cluster.

      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      Returns:
      The new number of cache nodes for the cluster.

      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    • hasCacheNodeIdsToRemove

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

    • cacheNodeIdsToRemove

      public final List<String> cacheNodeIdsToRemove()

      A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

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

      Returns:
      A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

    • engineVersion

      public final String engineVersion()

      The new cache engine version that the cluster runs.

      Returns:
      The new cache engine version that the cluster runs.

    • cacheNodeType

      public final String cacheNodeType()

      The cache node type that this cluster or replication group is scaled to.

      Returns:
      The cache node type that this cluster or replication group is scaled to.

    • authTokenStatus

      public final AuthTokenUpdateStatus authTokenStatus()

      The auth token status

      If the service returns an enum value that is not available in the current SDK version, authTokenStatus will return AuthTokenUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTokenStatusAsString().

      Returns:
      The auth token status
      See Also:

    • authTokenStatusAsString

      public final String authTokenStatusAsString()

      The auth token status

      If the service returns an enum value that is not available in the current SDK version, authTokenStatus will return AuthTokenUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTokenStatusAsString().

      Returns:
      The auth token status
      See Also:

    • hasLogDeliveryConfigurations

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

    • logDeliveryConfigurations

      public final List<PendingLogDeliveryConfiguration> logDeliveryConfigurations()

      The log delivery configurations being modified

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

      Returns:
      The log delivery configurations being modified

    • transitEncryptionEnabled

      public final Boolean transitEncryptionEnabled()

      A flag that enables in-transit encryption when set to true.

      Returns:
      A flag that enables in-transit encryption when set to true.

    • transitEncryptionMode

      public final TransitEncryptionMode transitEncryptionMode()

      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

      If the service returns an enum value that is not available in the current SDK version, transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitEncryptionModeAsString().

      Returns:
      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
      See Also:

    • transitEncryptionModeAsString

      public final String transitEncryptionModeAsString()

      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

      If the service returns an enum value that is not available in the current SDK version, transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitEncryptionModeAsString().

      Returns:
      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
      See Also:

    • toBuilder

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

    • builder

      public static PendingModifiedValues.Builder builder()

    • serializableBuilderClass

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