Class LifecycleHook

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

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

See Also:

  • Method Details

    • lifecycleHookName

      public final String lifecycleHookName()

      The name of the lifecycle hook.

      Returns:
      The name of the lifecycle hook.

    • autoScalingGroupName

      public final String autoScalingGroupName()

      The name of the Auto Scaling group for the lifecycle hook.

      Returns:
      The name of the Auto Scaling group for the lifecycle hook.

    • lifecycleTransition

      public final String lifecycleTransition()

      The lifecycle transition.

      Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

      Returns:
      The lifecycle transition.

      Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

    • notificationTargetARN

      public final String notificationTargetARN()

      The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

      Returns:
      The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

    • roleARN

      public final String roleARN()

      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

      Returns:
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

    • notificationMetadata

      public final String notificationMetadata()

      Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

      Returns:
      Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

    • heartbeatTimeout

      public final Integer heartbeatTimeout()

      The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

      Returns:
      The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

    • globalTimeout

      public final Integer globalTimeout()

      The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

      Returns:
      The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

    • defaultResult

      public final String defaultResult()

      The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

      Valid values: CONTINUE | ABANDON

      Returns:
      The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

      Valid values: CONTINUE | ABANDON

    • toBuilder

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

    • builder

      public static LifecycleHook.Builder builder()

    • serializableBuilderClass

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