Class RetentionTriggers

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

Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.

See Also:

  • Method Details

    • terminateHookAbandon

      public final RetentionAction terminateHookAbandon()

      Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).

      Set to Retain to move instances to a Retained state. Set to Terminate for default termination behavior.

      Retained instances don't count toward desired capacity and remain until you call TerminateInstanceInAutoScalingGroup.

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

      Returns:
      Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).

      Set to Retain to move instances to a Retained state. Set to Terminate for default termination behavior.

      Retained instances don't count toward desired capacity and remain until you call TerminateInstanceInAutoScalingGroup.

      See Also:

    • terminateHookAbandonAsString

      public final String terminateHookAbandonAsString()

      Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).

      Set to Retain to move instances to a Retained state. Set to Terminate for default termination behavior.

      Retained instances don't count toward desired capacity and remain until you call TerminateInstanceInAutoScalingGroup.

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

      Returns:
      Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction).

      Set to Retain to move instances to a Retained state. Set to Terminate for default termination behavior.

      Retained instances don't count toward desired capacity and remain until you call TerminateInstanceInAutoScalingGroup.

      See Also:

    • toBuilder

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

    • builder

      public static RetentionTriggers.Builder builder()

    • serializableBuilderClass

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