put_lifecycle_hook

put_lifecycle_hook(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_lifecycle_hook(
    LifecycleHookName='string',
    AutoScalingGroupName='string',
    LifecycleTransition='string',
    RoleARN='string',
    NotificationTargetARN='string',
    NotificationMetadata='string',
    HeartbeatTimeout=123,
    DefaultResult='string'
)

Parameters

• LifecycleHookName (string) --

  [REQUIRED]

  The name of the lifecycle hook.

• AutoScalingGroupName (string) --

  [REQUIRED]

  The name of the Auto Scaling group.

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

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

• 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" .

• NotificationMetadata (string) -- Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
• 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).
• 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

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• AutoScaling.Client.exceptions.LimitExceededFault
• AutoScaling.Client.exceptions.ResourceContentionFault

Examples

This example creates a lifecycle hook for instance launch.

response = client.put_lifecycle_hook(
    AutoScalingGroupName='my-auto-scaling-group',
    DefaultResult='CONTINUE',
    HeartbeatTimeout=300,
    LifecycleHookName='my-launch-lifecycle-hook',
    LifecycleTransition='autoscaling:EC2_INSTANCE_LAUNCHING',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}