PutPermission.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.CloudWatchEvents.PutPermission
-- Copyright   : (c) 2013-2017 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Running @PutPermission@ permits the specified AWS account to put events to your account's default /event bus/ . CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.
--
--
-- For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.
--
-- To enable multiple AWS accounts to put events to your default event bus, run @PutPermission@ once for each of these accounts.
--
-- The permission policy on the default event bus cannot exceed 10KB in size.
--
module Network.AWS.CloudWatchEvents.PutPermission
    (
    -- * Creating a Request
      putPermission
    , PutPermission
    -- * Request Lenses
    , ppAction
    , ppPrincipal
    , ppStatementId

    -- * Destructuring the Response
    , putPermissionResponse
    , PutPermissionResponse
    ) where

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

-- | /See:/ 'putPermission' smart constructor.
data PutPermission = PutPermission'
  { _ppAction      :: !Text
  , _ppPrincipal   :: !Text
  , _ppStatementId :: !Text
  } deriving (Eq, Read, Show, Data, Typeable, Generic)


-- | Creates a value of 'PutPermission' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'ppAction' - The action that you are enabling the other account to perform. Currently, this must be @events:PutEvents@ .
--
-- * 'ppPrincipal' - The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. If you specify "*", avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an @account@ field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
--
-- * 'ppStatementId' - An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this @StatementId@ when you run 'RemovePermission' .
putPermission
    :: Text -- ^ 'ppAction'
    -> Text -- ^ 'ppPrincipal'
    -> Text -- ^ 'ppStatementId'
    -> PutPermission
putPermission pAction_ pPrincipal_ pStatementId_ =
  PutPermission'
  { _ppAction = pAction_
  , _ppPrincipal = pPrincipal_
  , _ppStatementId = pStatementId_
  }


-- | The action that you are enabling the other account to perform. Currently, this must be @events:PutEvents@ .
ppAction :: Lens' PutPermission Text
ppAction = lens _ppAction (\ s a -> s{_ppAction = a});

-- | The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus. If you specify "*", avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an @account@ field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
ppPrincipal :: Lens' PutPermission Text
ppPrincipal = lens _ppPrincipal (\ s a -> s{_ppPrincipal = a});

-- | An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this @StatementId@ when you run 'RemovePermission' .
ppStatementId :: Lens' PutPermission Text
ppStatementId = lens _ppStatementId (\ s a -> s{_ppStatementId = a});

instance AWSRequest PutPermission where
        type Rs PutPermission = PutPermissionResponse
        request = postJSON cloudWatchEvents
        response = receiveNull PutPermissionResponse'

instance Hashable PutPermission where

instance NFData PutPermission where

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

instance ToJSON PutPermission where
        toJSON PutPermission'{..}
          = object
              (catMaybes
                 [Just ("Action" .= _ppAction),
                  Just ("Principal" .= _ppPrincipal),
                  Just ("StatementId" .= _ppStatementId)])

instance ToPath PutPermission where
        toPath = const "/"

instance ToQuery PutPermission where
        toQuery = const mempty

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


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


instance NFData PutPermissionResponse where