class Aws::AutoScaling::Types::LifecycleHookSpecification

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

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. **Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.**

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

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

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html

@note When making an API call, you may pass LifecycleHookSpecification

data as a hash:

    {
      lifecycle_hook_name: "AsciiStringMaxLen255", # required
      lifecycle_transition: "LifecycleTransition", # required
      notification_metadata: "XmlStringMaxLen1023",
      heartbeat_timeout: 1,
      default_result: "LifecycleActionResult",
      notification_target_arn: "NotificationTargetResourceName",
      role_arn: "XmlStringMaxLen255",
    }

@!attribute [rw] lifecycle_hook_name

The name of the lifecycle hook.
@return [String]

@!attribute [rw] lifecycle_transition

The state of the EC2 instance to which you want to attach the
lifecycle hook. The valid values are:

* autoscaling:EC2\_INSTANCE\_LAUNCHING

* autoscaling:EC2\_INSTANCE\_TERMINATING
@return [String]

@!attribute [rw] notification_metadata

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

@!attribute [rw] heartbeat_timeout

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` parameter. You
can prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
@return [Integer]

@!attribute [rw] default_result

Defines the action the Auto Scaling group should take when the
lifecycle hook timeout elapses or if an unexpected failure occurs.
The valid values are `CONTINUE` and `ABANDON`. The default value is
`ABANDON`.
@return [String]

@!attribute [rw] notification_target_arn

The ARN of the target that Amazon EC2 Auto Scaling sends
notifications to when an instance is in the transition state for the
lifecycle hook. The notification target can be either an SQS queue
or an SNS topic.
@return [String]

@!attribute [rw] role_arn

The ARN of the IAM role that allows the Auto Scaling group to
publish to the specified notification target, for example, an Amazon
SNS topic or an Amazon SQS queue.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LifecycleHookSpecification AWS API Documentation

Constants

SENSITIVE