Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of PutLifecycleHook.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
4. __If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.__
5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

See: AWS API Reference for RecordLifecycleActionHeartbeat.

Creating a Request

recordLifecycleActionHeartbeat

Arguments

:: Text

rlahLifecycleHookName

-> Text

rlahAutoScalingGroupName

-> Text

rlahLifecycleActionToken

-> RecordLifecycleActionHeartbeat

Creates a value of RecordLifecycleActionHeartbeat with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rlahLifecycleHookName
• rlahAutoScalingGroupName
• rlahLifecycleActionToken

data RecordLifecycleActionHeartbeat

See: recordLifecycleActionHeartbeat smart constructor.

Instances

Eq RecordLifecycleActionHeartbeat

Data RecordLifecycleActionHeartbeat

Read RecordLifecycleActionHeartbeat

Show RecordLifecycleActionHeartbeat

Generic RecordLifecycleActionHeartbeat

AWSRequest RecordLifecycleActionHeartbeat

ToPath RecordLifecycleActionHeartbeat

ToHeaders RecordLifecycleActionHeartbeat

ToQuery RecordLifecycleActionHeartbeat

Typeable * RecordLifecycleActionHeartbeat

type Rep RecordLifecycleActionHeartbeat

type Rs RecordLifecycleActionHeartbeat = RecordLifecycleActionHeartbeatResponse

Request Lenses

rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text

The name of the lifecycle hook.

rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text

The name of the Auto Scaling group for the hook.

rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat Text

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.

Destructuring the Response

recordLifecycleActionHeartbeatResponse

Arguments

:: Int

rlahrsStatus

-> RecordLifecycleActionHeartbeatResponse

Creates a value of RecordLifecycleActionHeartbeatResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rlahrsStatus

data RecordLifecycleActionHeartbeatResponse

See: recordLifecycleActionHeartbeatResponse smart constructor.

Instances

Eq RecordLifecycleActionHeartbeatResponse

Data RecordLifecycleActionHeartbeatResponse

Read RecordLifecycleActionHeartbeatResponse

Show RecordLifecycleActionHeartbeatResponse

Generic RecordLifecycleActionHeartbeatResponse

Typeable * RecordLifecycleActionHeartbeatResponse

type Rep RecordLifecycleActionHeartbeatResponse

Response Lenses

rlahrsStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int

The response status code.