Class WarmPoolConfiguration

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

Describes a warm pool configuration.

See Also:

  • Method Details

    • maxGroupPreparedCapacity

      public final Integer maxGroupPreparedCapacity()

      The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.

      Returns:
      The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.

    • minSize

      public final Integer minSize()

      The minimum number of instances to maintain in the warm pool.

      Returns:
      The minimum number of instances to maintain in the warm pool.

    • poolState

      public final WarmPoolState poolState()

      The instance state to transition to after the lifecycle actions are complete.

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

      Returns:
      The instance state to transition to after the lifecycle actions are complete.
      See Also:

    • poolStateAsString

      public final String poolStateAsString()

      The instance state to transition to after the lifecycle actions are complete.

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

      Returns:
      The instance state to transition to after the lifecycle actions are complete.
      See Also:

    • status

      public final WarmPoolStatus status()

      The status of a warm pool that is marked for deletion.

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

      Returns:
      The status of a warm pool that is marked for deletion.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a warm pool that is marked for deletion.

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

      Returns:
      The status of a warm pool that is marked for deletion.
      See Also:

    • instanceReusePolicy

      public final InstanceReusePolicy instanceReusePolicy()

      The instance reuse policy.

      Returns:
      The instance reuse policy.

    • toBuilder

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

    • builder

      public static WarmPoolConfiguration.Builder builder()

    • serializableBuilderClass

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