RECORDLCACTIONHEARTBEAT()`¶

About RecordLifecycleActionHeartbeat¶

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 the PutLifecycleHook API call.

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 Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_lifecyclehookname` `TYPE /AWS1/ASCASCIISTRINGMAXLEN255` `/AWS1/ASCASCIISTRINGMAXLEN255`¶

The name of the lifecycle hook.

`iv_autoscalinggroupname` `TYPE /AWS1/ASCRESOURCENAME` `/AWS1/ASCRESOURCENAME`¶

The name of the Auto Scaling group.

Optional arguments:¶

`iv_lifecycleactiontoken` `TYPE /AWS1/ASCLIFECYCLEACTIONTOKEN` `/AWS1/ASCLIFECYCLEACTIONTOKEN`¶

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

`iv_instanceid` `TYPE /AWS1/ASCXMLSTRINGMAXLEN19` `/AWS1/ASCXMLSTRINGMAXLEN19`¶

The ID of the instance.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ascrclcactheartbeat01` `/AWS1/CL_ASCRCLCACTHEARTBEAT01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_asc~recordlcactionheartbeat(
  iv_autoscalinggroupname = |string|
  iv_instanceid = |string|
  iv_lifecycleactiontoken = |string|
  iv_lifecyclehookname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

To record a lifecycle action heartbeat¶

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

DATA(lo_result) = lo_client->/aws1/if_asc~recordlcactionheartbeat(
  iv_autoscalinggroupname = |my-auto-scaling-group|
  iv_lifecycleactiontoken = |bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635|
  iv_lifecyclehookname = |my-lifecycle-hook|
).

/AWS1/IF_ASC=>RECORDLCACTIONHEARTBEAT()¶