RecordLifecycleActionHeartbeat.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.RecordLifecycleActionHeartbeat
-- 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)

-- | 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 <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_RecordLifecycleActionHeartbeat.html>
module Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat
    (
    -- * Request
      RecordLifecycleActionHeartbeat
    -- ** Request constructor
    , recordLifecycleActionHeartbeat
    -- ** Request lenses
    , rlahAutoScalingGroupName
    , rlahLifecycleActionToken
    , rlahLifecycleHookName

    -- * Response
    , RecordLifecycleActionHeartbeatResponse
    -- ** Response constructor
    , recordLifecycleActionHeartbeatResponse
    ) where

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

data RecordLifecycleActionHeartbeat = RecordLifecycleActionHeartbeat
    { _rlahAutoScalingGroupName :: Text
    , _rlahLifecycleActionToken :: Text
    , _rlahLifecycleHookName    :: Text
    } deriving (Eq, Ord, Show)

-- | 'RecordLifecycleActionHeartbeat' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'rlahAutoScalingGroupName' @::@ 'Text'
--
-- * 'rlahLifecycleActionToken' @::@ 'Text'
--
-- * 'rlahLifecycleHookName' @::@ 'Text'
--
recordLifecycleActionHeartbeat :: Text -- ^ 'rlahLifecycleHookName'
                               -> Text -- ^ 'rlahAutoScalingGroupName'
                               -> Text -- ^ 'rlahLifecycleActionToken'
                               -> RecordLifecycleActionHeartbeat
recordLifecycleActionHeartbeat p1 p2 p3 = RecordLifecycleActionHeartbeat
    { _rlahLifecycleHookName    = p1
    , _rlahAutoScalingGroupName = p2
    , _rlahLifecycleActionToken = p3
    }

-- | The name of the Auto Scaling group for the hook.
rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text
rlahAutoScalingGroupName =
    lens _rlahAutoScalingGroupName
        (\s a -> s { _rlahAutoScalingGroupName = a })

-- | 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.
rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat Text
rlahLifecycleActionToken =
    lens _rlahLifecycleActionToken
        (\s a -> s { _rlahLifecycleActionToken = a })

-- | The name of the lifecycle hook.
rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text
rlahLifecycleHookName =
    lens _rlahLifecycleHookName (\s a -> s { _rlahLifecycleHookName = a })

data RecordLifecycleActionHeartbeatResponse = RecordLifecycleActionHeartbeatResponse
    deriving (Eq, Ord, Show, Generic)

-- | 'RecordLifecycleActionHeartbeatResponse' constructor.
recordLifecycleActionHeartbeatResponse :: RecordLifecycleActionHeartbeatResponse
recordLifecycleActionHeartbeatResponse = RecordLifecycleActionHeartbeatResponse

instance ToPath RecordLifecycleActionHeartbeat where
    toPath = const "/"

instance ToQuery RecordLifecycleActionHeartbeat where
    toQuery RecordLifecycleActionHeartbeat{..} = mconcat
        [ "AutoScalingGroupName" =? _rlahAutoScalingGroupName
        , "LifecycleActionToken" =? _rlahLifecycleActionToken
        , "LifecycleHookName"    =? _rlahLifecycleHookName
        ]

instance ToHeaders RecordLifecycleActionHeartbeat

instance AWSRequest RecordLifecycleActionHeartbeat where
    type Sv RecordLifecycleActionHeartbeat = AutoScaling
    type Rs RecordLifecycleActionHeartbeat = RecordLifecycleActionHeartbeatResponse

    request  = post "RecordLifecycleActionHeartbeat"
    response = nullResponse RecordLifecycleActionHeartbeatResponse