AWS::AutoScaling::AutoScalingGroup LifecycleHookSpecification - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AutoScaling::AutoScalingGroup LifecycleHookSpecification

LifecycleHookSpecification specifies a lifecycle hook for the LifecycleHookSpecificationList property of the AWS::AutoScaling::AutoScalingGroup resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. You can find a sample template snippet in the Examples section of the AWS::AutoScaling::LifecycleHook resource.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "DefaultResult" : String,
  "HeartbeatTimeout" : Integer,
  "LifecycleHookName" : String,
  "LifecycleTransition" : String,
  "NotificationMetadata" : String,
  "NotificationTargetARN" : String,
  "RoleARN" : String
}

Properties

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

Required: No

Type: String

Update requires: No interruption

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

Required: No

Type: Integer

Update requires: No interruption

LifecycleHookName

The name of the lifecycle hook.

Required: Yes

Type: String

Pattern: [A-Za-z0-9\-_\/]+

Minimum: 1

Maximum: 255

Update requires: No interruption

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.

Required: Yes

Type: String

Update requires: No interruption

NotificationMetadata

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

Required: No

Type: String

Pattern: [\u0009\u000A\u000D\u0020-\u007e]+

Minimum: 1

Maximum: 4000

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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 Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

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

Required: No

Type: String

Update requires: No interruption