Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
- connectDirectory :: Text -> Text -> DirectorySize -> DirectoryConnectSettings -> ConnectDirectory
- data ConnectDirectory
- cdShortName :: Lens' ConnectDirectory (Maybe Text)
- cdDescription :: Lens' ConnectDirectory (Maybe Text)
- cdName :: Lens' ConnectDirectory Text
- cdPassword :: Lens' ConnectDirectory Text
- cdSize :: Lens' ConnectDirectory DirectorySize
- cdConnectSettings :: Lens' ConnectDirectory DirectoryConnectSettings
- connectDirectoryResponse :: Int -> ConnectDirectoryResponse
- data ConnectDirectoryResponse
- cdrsDirectoryId :: Lens' ConnectDirectoryResponse (Maybe Text)
- cdrsResponseStatus :: Lens' ConnectDirectoryResponse Int
Creating a Request
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 asCORP
.cdDescription
- A textual description for the directory.cdName
- The fully-qualified name of the on-premises directory, such ascorp.example.com
.cdPassword
- The password for the on-premises user account.cdSize
- The size of the directory.cdConnectSettings
- ADirectoryConnectSettings
object that contains additional information for the operation.
data ConnectDirectory Source #
Contains the inputs for the ConnectDirectory
operation.
See: connectDirectory
smart constructor.
Request Lenses
cdShortName :: Lens' ConnectDirectory (Maybe Text) Source #
The NetBIOS name of the on-premises directory, such as CORP
.
cdDescription :: Lens' ConnectDirectory (Maybe Text) Source #
A textual description for the directory.
cdName :: Lens' ConnectDirectory Text Source #
The fully-qualified name of the on-premises directory, such as corp.example.com
.
cdPassword :: Lens' ConnectDirectory Text Source #
The password for the on-premises user account.
cdSize :: Lens' ConnectDirectory DirectorySize Source #
The size of the directory.
cdConnectSettings :: Lens' ConnectDirectory DirectoryConnectSettings Source #
A DirectoryConnectSettings
object that contains additional information for the operation.
Destructuring the Response
connectDirectoryResponse Source #
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 Source #
Contains the results of the ConnectDirectory
operation.
See: connectDirectoryResponse
smart constructor.
Response Lenses
cdrsDirectoryId :: Lens' ConnectDirectoryResponse (Maybe Text) Source #
The identifier of the new directory.
cdrsResponseStatus :: Lens' ConnectDirectoryResponse Int Source #
- - | The response status code.