Documentation

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: newLifecycleHook smart constructor.

Create a value of LifecycleHook with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoScalingGroupName:LifecycleHook', lifecycleHook_autoScalingGroupName - The name of the Auto Scaling group for the lifecycle hook.

$sel:defaultResult:LifecycleHook', lifecycleHook_defaultResult - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Valid values: CONTINUE | ABANDON

$sel:globalTimeout:LifecycleHook', lifecycleHook_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.

$sel:heartbeatTimeout:LifecycleHook', lifecycleHook_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.

$sel:lifecycleHookName:LifecycleHook', lifecycleHook_lifecycleHookName - The name of the lifecycle hook.

$sel:lifecycleTransition:LifecycleHook', lifecycleHook_lifecycleTransition - The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

$sel:notificationMetadata:LifecycleHook', lifecycleHook_notificationMetadata - Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

$sel:notificationTargetARN:LifecycleHook', lifecycleHook_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.

$sel:roleARN:LifecycleHook', lifecycleHook_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).

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

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

Valid values: CONTINUE | ABANDON

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.

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.

The name of the lifecycle hook.

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

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

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.

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).