LifecycleHook
Describes a lifecycle hook. A lifecycle hook lets 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.
Contents
- AutoScalingGroupName
-
The name of the Auto Scaling group for the lifecycle hook.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- DefaultResult
-
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
Valid values:
CONTINUE|ABANDONType: String
Required: No
- GlobalTimeout
-
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.Type: Integer
Required: No
- HeartbeatTimeout
-
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
DefaultResultproperty.Type: Integer
Required: No
- LifecycleHookName
-
The name of the lifecycle hook.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z0-9\-_\/]+Required: No
- LifecycleTransition
-
The lifecycle transition.
Valid values:
autoscaling:EC2_INSTANCE_LAUNCHING|autoscaling:EC2_INSTANCE_TERMINATINGType: String
Required: No
- NotificationMetadata
-
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Pattern:
[\u0009\u000A\u000D\u0020-\u007e]+Required: No
- NotificationTargetARN
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- RoleARN
-
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).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
