AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class PutLifecycleHookRequest : AmazonAutoScalingRequest IRequestEvents
The PutLifecycleHookRequest type exposes the following members
Name | Description | |
---|---|---|
PutLifecycleHookRequest() |
Name | Type | Description | |
---|---|---|---|
AutoScalingGroupName | System.String |
Gets and sets the property AutoScalingGroupName.
The name of the Auto Scaling group to which you want to assign the lifecycle hook. |
|
DefaultResult | System.String |
Gets and sets the property 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 |
|
HeartbeatTimeout | System.Int32 |
Gets and sets the property HeartbeatTimeout.
The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour). |
|
LifecycleHookName | System.String |
Gets and sets the property LifecycleHookName.
The name of the lifecycle hook. |
|
LifecycleTransition | System.String |
Gets and sets the property LifecycleTransition.
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes. This parameter is required for new lifecycle hooks, but optional when updating existing hooks. |
|
NotificationMetadata | System.String |
Gets and sets the property NotificationMetadata.
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. |
|
NotificationTargetARN | System.String |
Gets and sets the property NotificationTargetARN.
The ARN of the notification target that Auto Scaling will use 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. The notification messages sent to the target include the following information:
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, Auto Scaling sends it a test message. Test
messages contains the following additional key/value pair: |
|
RoleARN | System.String |
Gets and sets the property RoleARN.
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. This parameter is required for new lifecycle hooks, but optional when updating existing hooks. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8