amazonka-ds-1.6.0: Amazon Directory Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectoryService.ConnectDirectory

Contents

Description

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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference .

Synopsis

Creating a Request

connectDirectory #

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:

data ConnectDirectory #

Contains the inputs for the ConnectDirectory operation.

See: connectDirectory smart constructor.

Instances

Eq ConnectDirectory # 
Data ConnectDirectory # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConnectDirectory -> c ConnectDirectory #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConnectDirectory #

toConstr :: ConnectDirectory -> Constr #

dataTypeOf :: ConnectDirectory -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConnectDirectory) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConnectDirectory) #

gmapT :: (forall b. Data b => b -> b) -> ConnectDirectory -> ConnectDirectory #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConnectDirectory -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConnectDirectory -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConnectDirectory -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConnectDirectory -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConnectDirectory -> m ConnectDirectory #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConnectDirectory -> m ConnectDirectory #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConnectDirectory -> m ConnectDirectory #

Show ConnectDirectory # 
Generic ConnectDirectory # 
Hashable ConnectDirectory # 
ToJSON ConnectDirectory # 
NFData ConnectDirectory # 

Methods

rnf :: ConnectDirectory -> () #

AWSRequest ConnectDirectory # 
ToHeaders ConnectDirectory # 
ToPath ConnectDirectory # 
ToQuery ConnectDirectory # 
type Rep ConnectDirectory # 
type Rs ConnectDirectory # 

Request Lenses

cdShortName :: Lens' ConnectDirectory (Maybe Text) #

The NetBIOS name of the on-premises directory, such as CORP .

cdDescription :: Lens' ConnectDirectory (Maybe Text) #

A textual description for the directory.

cdName :: Lens' ConnectDirectory Text #

The fully-qualified name of the on-premises directory, such as corp.example.com .

cdPassword :: Lens' ConnectDirectory Text #

The password for the on-premises user account.

cdSize :: Lens' ConnectDirectory DirectorySize #

The size of the directory.

cdConnectSettings :: Lens' ConnectDirectory DirectoryConnectSettings #

A DirectoryConnectSettings object that contains additional information for the operation.

Destructuring the Response

connectDirectoryResponse #

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:

data ConnectDirectoryResponse #

Contains the results of the ConnectDirectory operation.

See: connectDirectoryResponse smart constructor.

Instances

Eq ConnectDirectoryResponse # 
Data ConnectDirectoryResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConnectDirectoryResponse -> c ConnectDirectoryResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConnectDirectoryResponse #

toConstr :: ConnectDirectoryResponse -> Constr #

dataTypeOf :: ConnectDirectoryResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConnectDirectoryResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConnectDirectoryResponse) #

gmapT :: (forall b. Data b => b -> b) -> ConnectDirectoryResponse -> ConnectDirectoryResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConnectDirectoryResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConnectDirectoryResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConnectDirectoryResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConnectDirectoryResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConnectDirectoryResponse -> m ConnectDirectoryResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConnectDirectoryResponse -> m ConnectDirectoryResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConnectDirectoryResponse -> m ConnectDirectoryResponse #

Read ConnectDirectoryResponse # 
Show ConnectDirectoryResponse # 
Generic ConnectDirectoryResponse # 
NFData ConnectDirectoryResponse # 
type Rep ConnectDirectoryResponse # 
type Rep ConnectDirectoryResponse = D1 * (MetaData "ConnectDirectoryResponse" "Network.AWS.DirectoryService.ConnectDirectory" "amazonka-ds-1.6.0-GmQtRfGRD6LI91OTzfkXGW" False) (C1 * (MetaCons "ConnectDirectoryResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdrsDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cdrsDirectoryId :: Lens' ConnectDirectoryResponse (Maybe Text) #

The identifier of the new directory.

cdrsResponseStatus :: Lens' ConnectDirectoryResponse Int #

  • - | The response status code.