Copyright	(c) 2013-2021 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)
Safe Haskell	None

Amazonka.DirectoryService.ConnectDirectory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an AD Connector to connect to a self-managed 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 Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Synopsis

data ConnectDirectory = ConnectDirectory' {
- shortName :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- name :: Text
- password :: Sensitive Text
- size :: DirectorySize
- connectSettings :: DirectoryConnectSettings
}
newConnectDirectory :: Text -> Text -> DirectorySize -> DirectoryConnectSettings -> ConnectDirectory
connectDirectory_shortName :: Lens' ConnectDirectory (Maybe Text)
connectDirectory_description :: Lens' ConnectDirectory (Maybe Text)
connectDirectory_tags :: Lens' ConnectDirectory (Maybe [Tag])
connectDirectory_name :: Lens' ConnectDirectory Text
connectDirectory_password :: Lens' ConnectDirectory Text
connectDirectory_size :: Lens' ConnectDirectory DirectorySize
connectDirectory_connectSettings :: Lens' ConnectDirectory DirectoryConnectSettings
data ConnectDirectoryResponse = ConnectDirectoryResponse' {
- directoryId :: Maybe Text
- httpStatus :: Int
}
newConnectDirectoryResponse :: Int -> ConnectDirectoryResponse
connectDirectoryResponse_directoryId :: Lens' ConnectDirectoryResponse (Maybe Text)
connectDirectoryResponse_httpStatus :: Lens' ConnectDirectoryResponse Int

Creating a Request

data ConnectDirectory Source #

Contains the inputs for the ConnectDirectory operation.

See: newConnectDirectory smart constructor.

Constructors

ConnectDirectory'

Fields

shortName :: Maybe Text
The NetBIOS name of your self-managed directory, such as CORP.
description :: Maybe Text
A description for the directory.
tags :: Maybe [Tag]
The tags to be assigned to AD Connector.
name :: Text
The fully qualified name of your self-managed directory, such as corp.example.com.
password :: Sensitive Text
The password for your self-managed user account.
size :: DirectorySize
The size of the directory.
connectSettings :: DirectoryConnectSettings
A DirectoryConnectSettings object that contains additional information for the operation.

Instances

Instances details

Eq ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods (==) :: ConnectDirectory -> ConnectDirectory -> Bool # (/=) :: ConnectDirectory -> ConnectDirectory -> Bool #
Show ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods showsPrec :: Int -> ConnectDirectory -> ShowS # show :: ConnectDirectory -> String # showList :: [ConnectDirectory] -> ShowS #
Generic ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Associated Types type Rep ConnectDirectory :: Type -> Type # Methods from :: ConnectDirectory -> Rep ConnectDirectory x # to :: Rep ConnectDirectory x -> ConnectDirectory #
NFData ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods rnf :: ConnectDirectory -> () #
Hashable ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods hashWithSalt :: Int -> ConnectDirectory -> Int # hash :: ConnectDirectory -> Int #
ToJSON ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods toJSON :: ConnectDirectory -> Value # toEncoding :: ConnectDirectory -> Encoding # toJSONList :: [ConnectDirectory] -> Value # toEncodingList :: [ConnectDirectory] -> Encoding #
AWSRequest ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Associated Types type AWSResponse ConnectDirectory # Methods request :: ConnectDirectory -> Request ConnectDirectory # response :: MonadResource m => Logger -> Service -> Proxy ConnectDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConnectDirectory))) #
ToHeaders ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods toHeaders :: ConnectDirectory -> [Header] #
ToPath ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods toPath :: ConnectDirectory -> ByteString #
ToQuery ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods toQuery :: ConnectDirectory -> QueryString #
type Rep ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory type Rep ConnectDirectory = D1 ('MetaData "ConnectDirectory" "Amazonka.DirectoryService.ConnectDirectory" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "ConnectDirectory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectorySize) :: S1 ('MetaSel ('Just "connectSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectoryConnectSettings)))))
type AWSResponse ConnectDirectory Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory type AWSResponse ConnectDirectory = ConnectDirectoryResponse

newConnectDirectory Source #

Arguments

:: Text	`$sel:name:ConnectDirectory'`
-> Text	`$sel:password:ConnectDirectory'`
-> DirectorySize	`$sel:size:ConnectDirectory'`
-> DirectoryConnectSettings	`$sel:connectSettings:ConnectDirectory'`
-> ConnectDirectory

Create a value of ConnectDirectory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shortName:ConnectDirectory', connectDirectory_shortName - The NetBIOS name of your self-managed directory, such as CORP.

$sel:description:ConnectDirectory', connectDirectory_description - A description for the directory.

$sel:tags:ConnectDirectory', connectDirectory_tags - The tags to be assigned to AD Connector.

$sel:name:ConnectDirectory', connectDirectory_name - The fully qualified name of your self-managed directory, such as corp.example.com.

$sel:password:ConnectDirectory', connectDirectory_password - The password for your self-managed user account.

$sel:size:ConnectDirectory', connectDirectory_size - The size of the directory.

$sel:connectSettings:ConnectDirectory', connectDirectory_connectSettings - A DirectoryConnectSettings object that contains additional information for the operation.

Request Lenses

connectDirectory_shortName :: Lens' ConnectDirectory (Maybe Text) Source #

The NetBIOS name of your self-managed directory, such as CORP.

connectDirectory_description :: Lens' ConnectDirectory (Maybe Text) Source #

A description for the directory.

connectDirectory_tags :: Lens' ConnectDirectory (Maybe [Tag]) Source #

The tags to be assigned to AD Connector.

connectDirectory_name :: Lens' ConnectDirectory Text Source #

The fully qualified name of your self-managed directory, such as corp.example.com.

connectDirectory_password :: Lens' ConnectDirectory Text Source #

The password for your self-managed user account.

connectDirectory_size :: Lens' ConnectDirectory DirectorySize Source #

The size of the directory.

connectDirectory_connectSettings :: Lens' ConnectDirectory DirectoryConnectSettings Source #

A DirectoryConnectSettings object that contains additional information for the operation.

Destructuring the Response

data ConnectDirectoryResponse Source #

Contains the results of the ConnectDirectory operation.

See: newConnectDirectoryResponse smart constructor.

Constructors

ConnectDirectoryResponse'
Fields directoryId :: Maybe Text The identifier of the new directory. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods (==) :: ConnectDirectoryResponse -> ConnectDirectoryResponse -> Bool # (/=) :: ConnectDirectoryResponse -> ConnectDirectoryResponse -> Bool #
Read ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods readsPrec :: Int -> ReadS ConnectDirectoryResponse # readList :: ReadS [ConnectDirectoryResponse] # readPrec :: ReadPrec ConnectDirectoryResponse # readListPrec :: ReadPrec [ConnectDirectoryResponse] #
Show ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods showsPrec :: Int -> ConnectDirectoryResponse -> ShowS # show :: ConnectDirectoryResponse -> String # showList :: [ConnectDirectoryResponse] -> ShowS #
Generic ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Associated Types type Rep ConnectDirectoryResponse :: Type -> Type # Methods from :: ConnectDirectoryResponse -> Rep ConnectDirectoryResponse x # to :: Rep ConnectDirectoryResponse x -> ConnectDirectoryResponse #
NFData ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory Methods rnf :: ConnectDirectoryResponse -> () #
type Rep ConnectDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.ConnectDirectory type Rep ConnectDirectoryResponse = D1 ('MetaData "ConnectDirectoryResponse" "Amazonka.DirectoryService.ConnectDirectory" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "ConnectDirectoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newConnectDirectoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:ConnectDirectoryResponse'`
-> ConnectDirectoryResponse

Create a value of ConnectDirectoryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directoryId:ConnectDirectoryResponse', connectDirectoryResponse_directoryId - The identifier of the new directory.

$sel:httpStatus:ConnectDirectoryResponse', connectDirectoryResponse_httpStatus - The response's http status code.

Response Lenses

connectDirectoryResponse_directoryId :: Lens' ConnectDirectoryResponse (Maybe Text) Source #

The identifier of the new directory.

connectDirectoryResponse_httpStatus :: Lens' ConnectDirectoryResponse Int Source #

The response's http status code.