| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat
Description
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:
- (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.
- (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.
- 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 pending state.__
- If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
- recordLifecycleActionHeartbeat :: Text -> Text -> RecordLifecycleActionHeartbeat
- data RecordLifecycleActionHeartbeat
- rlahInstanceId :: Lens' RecordLifecycleActionHeartbeat (Maybe Text)
- rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat (Maybe Text)
- rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text
- rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text
- recordLifecycleActionHeartbeatResponse :: Int -> RecordLifecycleActionHeartbeatResponse
- data RecordLifecycleActionHeartbeatResponse
- rlahrsResponseStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int
Creating a Request
recordLifecycleActionHeartbeat Source
Arguments
| :: Text | |
| -> Text | |
| -> 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:
data RecordLifecycleActionHeartbeat Source
See: recordLifecycleActionHeartbeat smart constructor.
Instances
Request Lenses
rlahInstanceId :: Lens' RecordLifecycleActionHeartbeat (Maybe Text) Source
The ID of the instance.
rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat (Maybe Text) Source
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.
rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text Source
The name of the lifecycle hook.
rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text Source
The name of the Auto Scaling group for the hook.
Destructuring the Response
recordLifecycleActionHeartbeatResponse Source
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:
data RecordLifecycleActionHeartbeatResponse Source
See: recordLifecycleActionHeartbeatResponse smart constructor.
Instances
Response Lenses
rlahrsResponseStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int Source
The response status code.