Class LifecycleHookSpecification

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

Describes information used to specify a lifecycle hook for an Auto Scaling group.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

See Also:

  • Method Details

    • lifecycleHookName

      public final String lifecycleHookName()

      The name of the lifecycle hook.

      Returns:
      The name of the lifecycle hook.

    • lifecycleTransition

      public final String lifecycleTransition()

      The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

      • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.

      • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

      Returns:
      The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

      • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.

      • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING .

    • notificationMetadata

      public final String notificationMetadata()

      Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

      Returns:
      Additional information that you want to include 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. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

      Returns:
      The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

    • defaultResult

      public final String defaultResult()

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

      Valid values: CONTINUE | ABANDON

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

      Valid values: CONTINUE | ABANDON

    • notificationTargetARN

      public final String notificationTargetARN()

      The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

      Returns:
      The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

    • roleARN

      public final String roleARN()

      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Valid only if the notification target is 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. For information about creating this role, see Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

      Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

    • toBuilder

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

    • builder

      public static LifecycleHookSpecification.Builder builder()

    • serializableBuilderClass

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