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.

Completes the lifecycle action for the specified token or instance with the specified result.

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 in the Auto Scaling User Guide.

Note:

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

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

Syntax

C#
public virtual CompleteLifecycleActionResponse CompleteLifecycleAction(
         CompleteLifecycleActionRequest request
)
Parameters
request
Type: Amazon.AutoScaling.Model.CompleteLifecycleActionRequest

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

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

Exceptions

ExceptionCondition
ResourceContentionException You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.

To complete the lifecycle action


var response = client.CompleteLifecycleAction(new CompleteLifecycleActionRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    LifecycleActionResult = "CONTINUE",
    LifecycleActionToken = "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
    LifecycleHookName = "my-lifecycle-hook"
});


            

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