Copyright | (c) 2013-2015 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 |
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:
- Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
- Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
- Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
- __If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.__
- 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.
- recordLifecycleActionHeartbeat :: Text -> Text -> Text -> RecordLifecycleActionHeartbeat
- data RecordLifecycleActionHeartbeat
- rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text
- rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text
- rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat Text
- recordLifecycleActionHeartbeatResponse :: Int -> RecordLifecycleActionHeartbeatResponse
- data RecordLifecycleActionHeartbeatResponse
- rlahrsResponseStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int
Creating a Request
recordLifecycleActionHeartbeat Source
:: Text | |
-> 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.
Request Lenses
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.
rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat 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.
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.
Response Lenses
rlahrsResponseStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int Source
The response status code.