IAmazonAutoScaling.CompleteLifecycleAction Method (CompleteLifecycleActionRequest)

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:

(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(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 Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.

Note:

For .NET Core 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

public abstract CompleteLifecycleActionResponse CompleteLifecycleAction(
         CompleteLifecycleActionRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.CompleteLifecycleActionRequest

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

Return Value

Type: CompleteLifecycleActionResponse

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

Exceptions

Exception	Condition
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 client = new AmazonAutoScalingClient();
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

IAmazonAutoScaling.CompleteLifecycleAction (CompleteLifecycleActionRequest)

Method