CompleteLifecycleAction.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.AutoScaling.CompleteLifecycleAction
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | Completes the lifecycle action for the associated token initiated under the
-- given lifecycle hook with the specified result.
--
-- 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 <http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html Auto Scaling Pending State> and <http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html Auto Scaling Terminating State> in the /Auto Scaling Developer Guide/.
--
-- <http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_CompleteLifecycleAction.html>
module Network.AWS.AutoScaling.CompleteLifecycleAction
    (
    -- * Request
      CompleteLifecycleAction
    -- ** Request constructor
    , completeLifecycleAction
    -- ** Request lenses
    , claAutoScalingGroupName
    , claLifecycleActionResult
    , claLifecycleActionToken
    , claLifecycleHookName

    -- * Response
    , CompleteLifecycleActionResponse
    -- ** Response constructor
    , completeLifecycleActionResponse
    ) where

import Network.AWS.Prelude
import Network.AWS.Request.Query
import Network.AWS.AutoScaling.Types
import qualified GHC.Exts

data CompleteLifecycleAction = CompleteLifecycleAction
    { _claAutoScalingGroupName  :: Text
    , _claLifecycleActionResult :: Text
    , _claLifecycleActionToken  :: Text
    , _claLifecycleHookName     :: Text
    } deriving (Eq, Ord, Read, Show)

-- | 'CompleteLifecycleAction' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'claAutoScalingGroupName' @::@ 'Text'
--
-- * 'claLifecycleActionResult' @::@ 'Text'
--
-- * 'claLifecycleActionToken' @::@ 'Text'
--
-- * 'claLifecycleHookName' @::@ 'Text'
--
completeLifecycleAction :: Text -- ^ 'claLifecycleHookName'
                        -> Text -- ^ 'claAutoScalingGroupName'
                        -> Text -- ^ 'claLifecycleActionToken'
                        -> Text -- ^ 'claLifecycleActionResult'
                        -> CompleteLifecycleAction
completeLifecycleAction p1 p2 p3 p4 = CompleteLifecycleAction
    { _claLifecycleHookName     = p1
    , _claAutoScalingGroupName  = p2
    , _claLifecycleActionToken  = p3
    , _claLifecycleActionResult = p4
    }

-- | The name of the group for the lifecycle hook.
claAutoScalingGroupName :: Lens' CompleteLifecycleAction Text
claAutoScalingGroupName =
    lens _claAutoScalingGroupName (\s a -> s { _claAutoScalingGroupName = a })

-- | The action for the group to take. This parameter can be either 'CONTINUE' or 'ABANDON'.
claLifecycleActionResult :: Lens' CompleteLifecycleAction Text
claLifecycleActionResult =
    lens _claLifecycleActionResult
        (\s a -> s { _claLifecycleActionResult = a })

-- | 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.
claLifecycleActionToken :: Lens' CompleteLifecycleAction Text
claLifecycleActionToken =
    lens _claLifecycleActionToken (\s a -> s { _claLifecycleActionToken = a })

-- | The name of the lifecycle hook.
claLifecycleHookName :: Lens' CompleteLifecycleAction Text
claLifecycleHookName =
    lens _claLifecycleHookName (\s a -> s { _claLifecycleHookName = a })

data CompleteLifecycleActionResponse = CompleteLifecycleActionResponse
    deriving (Eq, Ord, Read, Show, Generic)

-- | 'CompleteLifecycleActionResponse' constructor.
completeLifecycleActionResponse :: CompleteLifecycleActionResponse
completeLifecycleActionResponse = CompleteLifecycleActionResponse

instance ToPath CompleteLifecycleAction where
    toPath = const "/"

instance ToQuery CompleteLifecycleAction where
    toQuery CompleteLifecycleAction{..} = mconcat
        [ "AutoScalingGroupName"  =? _claAutoScalingGroupName
        , "LifecycleActionResult" =? _claLifecycleActionResult
        , "LifecycleActionToken"  =? _claLifecycleActionToken
        , "LifecycleHookName"     =? _claLifecycleHookName
        ]

instance ToHeaders CompleteLifecycleAction

instance AWSRequest CompleteLifecycleAction where
    type Sv CompleteLifecycleAction = AutoScaling
    type Rs CompleteLifecycleAction = CompleteLifecycleActionResponse

    request  = post "CompleteLifecycleAction"
    response = nullResponse CompleteLifecycleActionResponse