CompleteLifecycleActionRequest Class

Container for the parameters to the CompleteLifecycleAction operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.CompleteLifecycleActionRequest

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

Syntax

public class CompleteLifecycleActionRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The CompleteLifecycleActionRequest type exposes the following members

Constructors

	Name	Description
	CompleteLifecycleActionRequest()

Properties

Name	Type	Description
AutoScalingGroupName	System.String	Gets and sets the property AutoScalingGroupName. The name of the Auto Scaling group.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance.
LifecycleActionResult	System.String	Gets and sets the property LifecycleActionResult. The action for the group to take. You can specify either `CONTINUE` or `ABANDON`.
LifecycleActionToken	System.String	Gets and sets the property LifecycleActionToken. A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
LifecycleHookName	System.String	Gets and sets the property LifecycleHookName. The name of the lifecycle hook.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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