ConnectDirectory.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.DirectoryService.ConnectDirectory
-- Copyright   : (c) 2013-2018 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)
--
-- Creates an AD Connector to connect to an on-premises directory.
--
--
-- Before you call /ConnectDirectory/ , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the /ConnectDirectory/ operation, see <http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference> .
--
module Network.AWS.DirectoryService.ConnectDirectory
    (
    -- * Creating a Request
      connectDirectory
    , ConnectDirectory
    -- * Request Lenses
    , cdShortName
    , cdDescription
    , cdName
    , cdPassword
    , cdSize
    , cdConnectSettings

    -- * Destructuring the Response
    , connectDirectoryResponse
    , ConnectDirectoryResponse
    -- * Response Lenses
    , cdrsDirectoryId
    , cdrsResponseStatus
    ) where

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

-- | Contains the inputs for the 'ConnectDirectory' operation.
--
--
--
-- /See:/ 'connectDirectory' smart constructor.
data ConnectDirectory = ConnectDirectory'
  { _cdShortName       :: !(Maybe Text)
  , _cdDescription     :: !(Maybe Text)
  , _cdName            :: !Text
  , _cdPassword        :: !(Sensitive Text)
  , _cdSize            :: !DirectorySize
  , _cdConnectSettings :: !DirectoryConnectSettings
  } deriving (Eq, Show, Data, Typeable, Generic)


-- | Creates a value of 'ConnectDirectory' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'cdShortName' - The NetBIOS name of the on-premises directory, such as @CORP@ .
--
-- * 'cdDescription' - A textual description for the directory.
--
-- * 'cdName' - The fully-qualified name of the on-premises directory, such as @corp.example.com@ .
--
-- * 'cdPassword' - The password for the on-premises user account.
--
-- * 'cdSize' - The size of the directory.
--
-- * 'cdConnectSettings' - A 'DirectoryConnectSettings' object that contains additional information for the operation.
connectDirectory
    :: Text -- ^ 'cdName'
    -> Text -- ^ 'cdPassword'
    -> DirectorySize -- ^ 'cdSize'
    -> DirectoryConnectSettings -- ^ 'cdConnectSettings'
    -> ConnectDirectory
connectDirectory pName_ pPassword_ pSize_ pConnectSettings_ =
  ConnectDirectory'
    { _cdShortName = Nothing
    , _cdDescription = Nothing
    , _cdName = pName_
    , _cdPassword = _Sensitive # pPassword_
    , _cdSize = pSize_
    , _cdConnectSettings = pConnectSettings_
    }


-- | The NetBIOS name of the on-premises directory, such as @CORP@ .
cdShortName :: Lens' ConnectDirectory (Maybe Text)
cdShortName = lens _cdShortName (\ s a -> s{_cdShortName = a})

-- | A textual description for the directory.
cdDescription :: Lens' ConnectDirectory (Maybe Text)
cdDescription = lens _cdDescription (\ s a -> s{_cdDescription = a})

-- | The fully-qualified name of the on-premises directory, such as @corp.example.com@ .
cdName :: Lens' ConnectDirectory Text
cdName = lens _cdName (\ s a -> s{_cdName = a})

-- | The password for the on-premises user account.
cdPassword :: Lens' ConnectDirectory Text
cdPassword = lens _cdPassword (\ s a -> s{_cdPassword = a}) . _Sensitive

-- | The size of the directory.
cdSize :: Lens' ConnectDirectory DirectorySize
cdSize = lens _cdSize (\ s a -> s{_cdSize = a})

-- | A 'DirectoryConnectSettings' object that contains additional information for the operation.
cdConnectSettings :: Lens' ConnectDirectory DirectoryConnectSettings
cdConnectSettings = lens _cdConnectSettings (\ s a -> s{_cdConnectSettings = a})

instance AWSRequest ConnectDirectory where
        type Rs ConnectDirectory = ConnectDirectoryResponse
        request = postJSON directoryService
        response
          = receiveJSON
              (\ s h x ->
                 ConnectDirectoryResponse' <$>
                   (x .?> "DirectoryId") <*> (pure (fromEnum s)))

instance Hashable ConnectDirectory where

instance NFData ConnectDirectory where

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

instance ToJSON ConnectDirectory where
        toJSON ConnectDirectory'{..}
          = object
              (catMaybes
                 [("ShortName" .=) <$> _cdShortName,
                  ("Description" .=) <$> _cdDescription,
                  Just ("Name" .= _cdName),
                  Just ("Password" .= _cdPassword),
                  Just ("Size" .= _cdSize),
                  Just ("ConnectSettings" .= _cdConnectSettings)])

instance ToPath ConnectDirectory where
        toPath = const "/"

instance ToQuery ConnectDirectory where
        toQuery = const mempty

-- | Contains the results of the 'ConnectDirectory' operation.
--
--
--
-- /See:/ 'connectDirectoryResponse' smart constructor.
data ConnectDirectoryResponse = ConnectDirectoryResponse'
  { _cdrsDirectoryId    :: !(Maybe Text)
  , _cdrsResponseStatus :: !Int
  } deriving (Eq, Read, Show, Data, Typeable, Generic)


-- | Creates a value of 'ConnectDirectoryResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'cdrsDirectoryId' - The identifier of the new directory.
--
-- * 'cdrsResponseStatus' - -- | The response status code.
connectDirectoryResponse
    :: Int -- ^ 'cdrsResponseStatus'
    -> ConnectDirectoryResponse
connectDirectoryResponse pResponseStatus_ =
  ConnectDirectoryResponse'
    {_cdrsDirectoryId = Nothing, _cdrsResponseStatus = pResponseStatus_}


-- | The identifier of the new directory.
cdrsDirectoryId :: Lens' ConnectDirectoryResponse (Maybe Text)
cdrsDirectoryId = lens _cdrsDirectoryId (\ s a -> s{_cdrsDirectoryId = a})

-- | -- | The response status code.
cdrsResponseStatus :: Lens' ConnectDirectoryResponse Int
cdrsResponseStatus = lens _cdrsResponseStatus (\ s a -> s{_cdrsResponseStatus = a})

instance NFData ConnectDirectoryResponse where