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.

Container for the parameters to the RecordLifecycleActionHeartbeat operation. Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

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.

Inheritance Hierarchy

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

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

Syntax

C#
public class RecordLifecycleActionHeartbeatRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The RecordLifecycleActionHeartbeatRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group for the hook.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance.

Public Property LifecycleActionToken System.String

Gets and sets the property LifecycleActionToken.

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Public Property LifecycleHookName System.String

Gets and sets the property LifecycleHookName.

The name of the lifecycle hook.

Examples

This example records a lifecycle action heartbeat to keep the instance in a pending state.

To record a lifecycle action heartbeat


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


            

Version Information

.NET Standard:
Supported in: 1.3

.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