Class: LifecycleHook

AutoScaling.LifecycleHook

new LifecycleHook()

Properties:
Name Type Description
AutoScalingGroupName String Required: Yes. The name of the Auto Scaling group for the lifecycle hook.Update requires: Replacement
DefaultResult String Required: No. The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.Update requires: No interruption
HeartbeatTimeout Number Required: No. The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that you specified in the DefaultResult property.Update requires: No interruption
LifecycleTransition String Required: Yes. The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.Update requires: No interruption
NotificationMetadata String Required: No. Additional information that you want to include when Auto Scaling sends a message to the notification target.Update requires: No interruption
NotificationTargetARN String Required: Yes. The Amazon resource name (ARN) of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.Update requires: No interruption
RoleARN String Required: Yes. The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. The role requires permissions to Amazon SNS and Amazon SQS.Update requires: No interruption
Source:

Extends

  • WKResource

AutoScaling.LifecycleHook

new LifecycleHook()

Properties:
Name Type Description
AutoScalingGroupName String Required: Yes. The name of the Auto Scaling group for the lifecycle hook.Update requires: Replacement
DefaultResult String Required: No. The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.Update requires: No interruption
HeartbeatTimeout Number Required: No. The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that you specified in the DefaultResult property.Update requires: No interruption
LifecycleTransition String Required: Yes. The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.Update requires: No interruption
NotificationMetadata String Required: No. Additional information that you want to include when Auto Scaling sends a message to the notification target.Update requires: No interruption
NotificationTargetARN String Required: Yes. The Amazon resource name (ARN) of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.Update requires: No interruption
RoleARN String Required: Yes. The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. The role requires permissions to Amazon SNS and Amazon SQS.Update requires: No interruption
Source:

Extends

  • WKResource