AWS SDK Version 3 for .NET
API Reference

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.

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

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:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when 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 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.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle Hooks in the 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. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Note:

For PCL this operation is only available in asynchronous form. Please refer to PutLifecycleHookAsync.

Namespace: Amazon.AutoScaling
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public abstract PutLifecycleHookResponse PutLifecycleHook(
         PutLifecycleHookRequest request
)
Parameters
request
Type: Amazon.AutoScaling.Model.PutLifecycleHookRequest

Container for the necessary parameters to execute the PutLifecycleHook service method.

Return Value
The response from the PutLifecycleHook service method, as returned by AutoScaling.

Exceptions

ExceptionCondition
LimitExceededException You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.
ResourceContentionException You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

This example creates a lifecycle hook.

To create a lifecycle hook


var response = client.PutLifecycleHook(new PutLifecycleHookRequest 
{
    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"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also