SetTerminationProtection.hs

{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric      #-}
{-# LANGUAGE OverloadedStrings  #-}
{-# LANGUAGE RecordWildCards    #-}
{-# LANGUAGE TypeFamilies       #-}

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

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Network.AWS.EMR.SetTerminationProtection
-- 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)
--
-- SetTerminationProtection locks a job flow so the Amazon EC2 instances in
-- the cluster cannot be terminated by user intervention, an API call, or
-- in the event of a job-flow error. The cluster still terminates upon
-- successful completion of the job flow. Calling SetTerminationProtection
-- on a job flow is analogous to calling the Amazon EC2
-- DisableAPITermination API on all of the EC2 instances in a cluster.
--
-- SetTerminationProtection is used to prevent accidental termination of a
-- job flow and to ensure that in the event of an error, the instances will
-- persist so you can recover any data stored in their ephemeral instance
-- storage.
--
-- To terminate a job flow that has been locked by setting
-- SetTerminationProtection to 'true', you must first unlock the job flow
-- by a subsequent call to SetTerminationProtection in which you set the
-- value to 'false'.
--
-- For more information, go to
-- <http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/UsingEMR_TerminationProtection.html Protecting a Job Flow from Termination>
-- in the /Amazon Elastic MapReduce Developer\'s Guide./
module Network.AWS.EMR.SetTerminationProtection
    (
    -- * Creating a Request
      setTerminationProtection
    , SetTerminationProtection
    -- * Request Lenses
    , stpJobFlowIds
    , stpTerminationProtected

    -- * Destructuring the Response
    , setTerminationProtectionResponse
    , SetTerminationProtectionResponse
    ) where

import           Network.AWS.EMR.Types
import           Network.AWS.EMR.Types.Product
import           Network.AWS.Lens
import           Network.AWS.Prelude
import           Network.AWS.Request
import           Network.AWS.Response

-- | The input argument to the < TerminationProtection> operation.
--
-- /See:/ 'setTerminationProtection' smart constructor.
data SetTerminationProtection = SetTerminationProtection'
    { _stpJobFlowIds           :: ![Text]
    , _stpTerminationProtected :: !Bool
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'SetTerminationProtection' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'stpJobFlowIds'
--
-- * 'stpTerminationProtected'
setTerminationProtection
    :: Bool -- ^ 'stpTerminationProtected'
    -> SetTerminationProtection
setTerminationProtection pTerminationProtected_ =
    SetTerminationProtection'
    { _stpJobFlowIds = mempty
    , _stpTerminationProtected = pTerminationProtected_
    }

-- | A list of strings that uniquely identify the job flows to protect. This
-- identifier is returned by < RunJobFlow> and can also be obtained from
-- < DescribeJobFlows> .
stpJobFlowIds :: Lens' SetTerminationProtection [Text]
stpJobFlowIds = lens _stpJobFlowIds (\ s a -> s{_stpJobFlowIds = a}) . _Coerce;

-- | A Boolean that indicates whether to protect the job flow and prevent the
-- Amazon EC2 instances in the cluster from shutting down due to API calls,
-- user intervention, or job-flow error.
stpTerminationProtected :: Lens' SetTerminationProtection Bool
stpTerminationProtected = lens _stpTerminationProtected (\ s a -> s{_stpTerminationProtected = a});

instance AWSRequest SetTerminationProtection where
        type Rs SetTerminationProtection =
             SetTerminationProtectionResponse
        request = postJSON emr
        response
          = receiveNull SetTerminationProtectionResponse'

instance Hashable SetTerminationProtection

instance ToHeaders SetTerminationProtection where
        toHeaders
          = const
              (mconcat
                 ["X-Amz-Target" =#
                    ("ElasticMapReduce.SetTerminationProtection" ::
                       ByteString),
                  "Content-Type" =#
                    ("application/x-amz-json-1.1" :: ByteString)])

instance ToJSON SetTerminationProtection where
        toJSON SetTerminationProtection'{..}
          = object
              (catMaybes
                 [Just ("JobFlowIds" .= _stpJobFlowIds),
                  Just
                    ("TerminationProtected" .=
                       _stpTerminationProtected)])

instance ToPath SetTerminationProtection where
        toPath = const "/"

instance ToQuery SetTerminationProtection where
        toQuery = const mempty

-- | /See:/ 'setTerminationProtectionResponse' smart constructor.
data SetTerminationProtectionResponse =
    SetTerminationProtectionResponse'
    deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'SetTerminationProtectionResponse' with the minimum fields required to make a request.
--
setTerminationProtectionResponse
    :: SetTerminationProtectionResponse
setTerminationProtectionResponse = SetTerminationProtectionResponse'