| 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.CompleteLifecycleAction
Description
Completes the lifecycle action for the specified token or instance with the specified result.
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.
- completeLifecycleAction :: Text -> Text -> Text -> CompleteLifecycleAction
- data CompleteLifecycleAction
- claInstanceId :: Lens' CompleteLifecycleAction (Maybe Text)
- claLifecycleActionToken :: Lens' CompleteLifecycleAction (Maybe Text)
- claLifecycleHookName :: Lens' CompleteLifecycleAction Text
- claAutoScalingGroupName :: Lens' CompleteLifecycleAction Text
- claLifecycleActionResult :: Lens' CompleteLifecycleAction Text
- completeLifecycleActionResponse :: Int -> CompleteLifecycleActionResponse
- data CompleteLifecycleActionResponse
- clarsResponseStatus :: Lens' CompleteLifecycleActionResponse Int
Creating a Request
completeLifecycleAction Source
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CompleteLifecycleAction |
Creates a value of CompleteLifecycleAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CompleteLifecycleAction Source
See: completeLifecycleAction smart constructor.
Instances
Request Lenses
claInstanceId :: Lens' CompleteLifecycleAction (Maybe Text) Source
The ID of the instance.
claLifecycleActionToken :: Lens' CompleteLifecycleAction (Maybe Text) Source
A universally unique identifier (UUID) that 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.
claLifecycleHookName :: Lens' CompleteLifecycleAction Text Source
The name of the lifecycle hook.
claAutoScalingGroupName :: Lens' CompleteLifecycleAction Text Source
The name of the group for the lifecycle hook.
claLifecycleActionResult :: Lens' CompleteLifecycleAction Text Source
The action for the group to take. This parameter can be either
CONTINUE or ABANDON.
Destructuring the Response
completeLifecycleActionResponse Source
Arguments
| :: Int | |
| -> CompleteLifecycleActionResponse |
Creates a value of CompleteLifecycleActionResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CompleteLifecycleActionResponse Source
See: completeLifecycleActionResponse smart constructor.
Response Lenses
clarsResponseStatus :: Lens' CompleteLifecycleActionResponse Int Source
The response status code.