autoscaling_put_lifecycle_hook: Creates or updates a lifecycle hook for the specified Auto...

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (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.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using the record_lifecycle_action_heartbeat API call.

  5. If you finish before the timeout period ends, complete the lifecycle action using the complete_lifecycle_action 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 describe_lifecycle_hooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the delete_lifecycle_hook API.

Usage

1
2
3
autoscaling_put_lifecycle_hook(LifecycleHookName, AutoScalingGroupName,
  LifecycleTransition, RoleARN, NotificationTargetARN,
  NotificationMetadata, HeartbeatTimeout, DefaultResult)

Arguments

LifecycleHookName

[required] The name of the lifecycle hook.

AutoScalingGroupName

[required] The name of the Auto Scaling group.

LifecycleTransition

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

RoleARN

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Required for new lifecycle hooks, but optional when updating existing hooks.

NotificationTargetARN

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

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

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

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

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the record_lifecycle_action_heartbeat API.

DefaultResult

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$put_lifecycle_hook(
  LifecycleHookName = "string",
  AutoScalingGroupName = "string",
  LifecycleTransition = "string",
  RoleARN = "string",
  NotificationTargetARN = "string",
  NotificationMetadata = "string",
  HeartbeatTimeout = 123,
  DefaultResult = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# This example creates a lifecycle hook.
svc$put_lifecycle_hook(
  AutoScalingGroupName = "my-auto-scaling-group",
  LifecycleHookName = "my-lifecycle-hook",
  LifecycleTransition = "autoscaling:EC2_INSTANCE_LAUNCHING",
  NotificationTargetARN = "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn",
  RoleARN = "arn:aws:iam::123456789012:role/my-auto-scaling-role"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.