Documentation

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.

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:defaultResult:LifecycleHook', lifecycleHook_defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

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

$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 parameter.

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

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

$sel:globalTimeout:LifecycleHook', lifecycleHook_globalTimeout - The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

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

$sel:lifecycleTransition:LifecycleHook', lifecycleHook_lifecycleTransition - The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

• autoscaling:EC2_INSTANCE_LAUNCHING
• autoscaling:EC2_INSTANCE_TERMINATING

$sel:roleARN:LifecycleHook', lifecycleHook_roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

The name of the lifecycle hook.

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.

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

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

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

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.

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

• autoscaling:EC2_INSTANCE_LAUNCHING
• autoscaling:EC2_INSTANCE_TERMINATING

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.