Documentation

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

Create a value of LifecycleHookSpecification 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:LifecycleHookSpecification', lifecycleHookSpecification_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

$sel:heartbeatTimeout:LifecycleHookSpecification', lifecycleHookSpecification_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).

$sel:notificationMetadata:LifecycleHookSpecification', lifecycleHookSpecification_notificationMetadata - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

$sel:notificationTargetARN:LifecycleHookSpecification', lifecycleHookSpecification_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.

$sel:roleARN:LifecycleHookSpecification', lifecycleHookSpecification_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 Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.

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

$sel:lifecycleHookName:LifecycleHookSpecification', lifecycleHookSpecification_lifecycleHookName - The name of the lifecycle hook.

$sel:lifecycleTransition:LifecycleHookSpecification', lifecycleHookSpecification_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.

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

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

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

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.

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 Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.

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

The name of the lifecycle hook.

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.