Network.AWS.DirectoryService.ConnectDirectory

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 .

Creating a Request

connectDirectory

Arguments

:: Text

cdName

-> Text

cdPassword

-> DirectorySize

cdSize

-> DirectoryConnectSettings

cdConnectSettings

-> 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:

• 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.

data ConnectDirectory

Contains the inputs for the ConnectDirectory operation.

See: connectDirectory smart constructor.

Instances

Eq ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

(==) :: ConnectDirectory -> ConnectDirectory -> Bool

(/=) :: ConnectDirectory -> ConnectDirectory -> Bool

Data ConnectDirectory

Defined in Network.AWS.DirectoryService.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

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

showsPrec :: Int -> ConnectDirectory -> ShowS

show :: ConnectDirectory -> String

showList :: [ConnectDirectory] -> ShowS

Generic ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Associated Types

type Rep ConnectDirectory :: Type -> Type

Methods

from :: ConnectDirectory -> Rep ConnectDirectory x

to :: Rep ConnectDirectory x -> ConnectDirectory

Hashable ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

hashWithSalt :: Int -> ConnectDirectory -> Int

hash :: ConnectDirectory -> Int

ToJSON ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

toJSON :: ConnectDirectory -> Value

toEncoding :: ConnectDirectory -> Encoding

toJSONList :: [ConnectDirectory] -> Value

toEncodingList :: [ConnectDirectory] -> Encoding

AWSRequest ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Associated Types

type Rs ConnectDirectory :: Type

Methods

request :: ConnectDirectory -> Request ConnectDirectory

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ConnectDirectory -> ClientResponse -> m (Response ConnectDirectory)

ToHeaders ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

toHeaders :: ConnectDirectory -> [Header]

ToPath ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

toPath :: ConnectDirectory -> ByteString

ToQuery ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

toQuery :: ConnectDirectory -> QueryString

NFData ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

rnf :: ConnectDirectory -> ()

type Rep ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

type Rep ConnectDirectory = D1 (MetaData "ConnectDirectory" "Network.AWS.DirectoryService.ConnectDirectory" "amazonka-ds-1.6.1-GgbrksYrd5fGA0sALmSRaP" False) (C1 (MetaCons "ConnectDirectory'" PrefixI True) ((S1 (MetaSel (Just "_cdShortName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: (S1 (MetaSel (Just "_cdPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 (MetaSel (Just "_cdSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectorySize) :*: S1 (MetaSel (Just "_cdConnectSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectoryConnectSettings)))))

type Rs ConnectDirectory

Defined in Network.AWS.DirectoryService.ConnectDirectory

type Rs ConnectDirectory = ConnectDirectoryResponse

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

Arguments

:: Int

cdrsResponseStatus

-> 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:

• cdrsDirectoryId - The identifier of the new directory.
• cdrsResponseStatus - -- | The response status code.

data ConnectDirectoryResponse

Contains the results of the ConnectDirectory operation.

See: connectDirectoryResponse smart constructor.

Instances

Eq ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

(==) :: ConnectDirectoryResponse -> ConnectDirectoryResponse -> Bool

(/=) :: ConnectDirectoryResponse -> ConnectDirectoryResponse -> Bool

Data ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

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

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

readsPrec :: Int -> ReadS ConnectDirectoryResponse

readList :: ReadS [ConnectDirectoryResponse]

readPrec :: ReadPrec ConnectDirectoryResponse

readListPrec :: ReadPrec [ConnectDirectoryResponse]

Show ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

showsPrec :: Int -> ConnectDirectoryResponse -> ShowS

show :: ConnectDirectoryResponse -> String

showList :: [ConnectDirectoryResponse] -> ShowS

Generic ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

Associated Types

type Rep ConnectDirectoryResponse :: Type -> Type

Methods

from :: ConnectDirectoryResponse -> Rep ConnectDirectoryResponse x

to :: Rep ConnectDirectoryResponse x -> ConnectDirectoryResponse

NFData ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

Methods

rnf :: ConnectDirectoryResponse -> ()

type Rep ConnectDirectoryResponse

Defined in Network.AWS.DirectoryService.ConnectDirectory

type Rep ConnectDirectoryResponse = D1 (MetaData "ConnectDirectoryResponse" "Network.AWS.DirectoryService.ConnectDirectory" "amazonka-ds-1.6.1-GgbrksYrd5fGA0sALmSRaP" False) (C1 (MetaCons "ConnectDirectoryResponse'" PrefixI True) (S1 (MetaSel (Just "_cdrsDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_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.