lifecycle_hooks

Creates, updates, deletes, gets or lists a lifecycle_hooks resource.

Overview

Name	lifecycle_hooks
Type	Resource
Id	aws.autoscaling.lifecycle_hooks

Fields

The following fields are returned by SELECT queries:

describe_lifecycle_hooks

Name	Datatype	Description
auto_scaling_group_name	string	The name of the Auto Scaling group for the lifecycle hook.
default_result	string	The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. Valid values: CONTINUE | ABANDON
global_timeout	integer	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.
heartbeat_timeout	integer	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.
lifecycle_hook_name	string	The name of the lifecycle hook.
lifecycle_transition	string	The lifecycle transition. Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING
notification_metadata	string	Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
notification_target_arn	string	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.
role_arn	string	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).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_lifecycle_hooks	select	AutoScalingGroupName, region	LifecycleHookNames	Gets information about the lifecycle hooks for the specified Auto Scaling group.
put_lifecycle_hook	replace	LifecycleHookName, AutoScalingGroupName, region	LifecycleTransition, RoleARN, NotificationTargetARN, NotificationMetadata, HeartbeatTimeout, DefaultResult	Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let 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. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (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. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
delete_lifecycle_hook	delete	LifecycleHookName, AutoScalingGroupName, region		Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
AutoScalingGroupName	string	The name of the Auto Scaling group.
LifecycleHookName	string	The name of the lifecycle hook.
region	string	AWS region (default: us-east-1)
DefaultResult	string	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
HeartbeatTimeout	integer	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).
LifecycleHookNames	array	The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.
LifecycleTransition	string	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. Required for new lifecycle hooks, but optional when updating existing hooks.
NotificationMetadata	string	Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
NotificationTargetARN	string	The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
RoleARN	string	The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

SELECT examples

describe_lifecycle_hooks

Gets information about the lifecycle hooks for the specified Auto Scaling group.

SELECT
auto_scaling_group_name,
default_result,
global_timeout,
heartbeat_timeout,
lifecycle_hook_name,
lifecycle_transition,
notification_metadata,
notification_target_arn,
role_arn
FROM aws.autoscaling.lifecycle_hooks
WHERE AutoScalingGroupName = '{{ AutoScalingGroupName }}' -- required
AND region = '{{ region }}' -- required
AND LifecycleHookNames = '{{ LifecycleHookNames }}'
;

REPLACE examples

put_lifecycle_hook

Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let 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. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (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. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

REPLACE aws.autoscaling.lifecycle_hooks
SET 
-- No updatable properties
WHERE 
LifecycleHookName = '{{ LifecycleHookName }}' --required
AND AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND region = '{{ region }}' --required
AND LifecycleTransition = '{{ LifecycleTransition}}'
AND RoleARN = '{{ RoleARN}}'
AND NotificationTargetARN = '{{ NotificationTargetARN}}'
AND NotificationMetadata = '{{ NotificationMetadata}}'
AND HeartbeatTimeout = '{{ HeartbeatTimeout}}'
AND DefaultResult = '{{ DefaultResult}}';

DELETE examples

delete_lifecycle_hook

Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

DELETE FROM aws.autoscaling.lifecycle_hooks
WHERE LifecycleHookName = '{{ LifecycleHookName }}' --required
AND AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND region = '{{ region }}' --required
;