| 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.CreateDirectory
Description
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required
permissions have been explicitly granted through a policy. For details
about what permissions are required to run the CreateDirectory
operation, see
Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Synopsis
- data CreateDirectory = CreateDirectory' {
- shortName :: Maybe Text
- vpcSettings :: Maybe DirectoryVpcSettings
- description :: Maybe Text
- tags :: Maybe [Tag]
- name :: Text
- password :: Sensitive Text
- size :: DirectorySize
- newCreateDirectory :: Text -> Text -> DirectorySize -> CreateDirectory
- createDirectory_shortName :: Lens' CreateDirectory (Maybe Text)
- createDirectory_vpcSettings :: Lens' CreateDirectory (Maybe DirectoryVpcSettings)
- createDirectory_description :: Lens' CreateDirectory (Maybe Text)
- createDirectory_tags :: Lens' CreateDirectory (Maybe [Tag])
- createDirectory_name :: Lens' CreateDirectory Text
- createDirectory_password :: Lens' CreateDirectory Text
- createDirectory_size :: Lens' CreateDirectory DirectorySize
- data CreateDirectoryResponse = CreateDirectoryResponse' {
- directoryId :: Maybe Text
- httpStatus :: Int
- newCreateDirectoryResponse :: Int -> CreateDirectoryResponse
- createDirectoryResponse_directoryId :: Lens' CreateDirectoryResponse (Maybe Text)
- createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int
Creating a Request
data CreateDirectory Source #
Contains the inputs for the CreateDirectory operation.
See: newCreateDirectory smart constructor.
Constructors
| CreateDirectory' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DirectorySize | |
| -> CreateDirectory |
Create a value of CreateDirectory 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:CreateDirectory', createDirectory_shortName - The NetBIOS name of the directory, such as CORP.
$sel:vpcSettings:CreateDirectory', createDirectory_vpcSettings - A DirectoryVpcSettings object that contains additional information for
the operation.
$sel:description:CreateDirectory', createDirectory_description - A description for the directory.
$sel:tags:CreateDirectory', createDirectory_tags - The tags to be assigned to the Simple AD directory.
$sel:name:CreateDirectory', createDirectory_name - The fully qualified name for the directory, such as corp.example.com.
$sel:password:CreateDirectory', createDirectory_password - The password for the directory administrator. The directory creation
process creates a directory administrator account with the user name
Administrator and this password.
If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
The regex pattern for this string is made up of the following conditions:
- Length (?=^.{8,64}$) – Must be between 8 and 64 characters
AND any 3 of the following password complexity rules required by Active Directory:
- Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
- Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
- Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
- Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])
For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
$sel:size:CreateDirectory', createDirectory_size - The size of the directory.
Request Lenses
createDirectory_shortName :: Lens' CreateDirectory (Maybe Text) Source #
The NetBIOS name of the directory, such as CORP.
createDirectory_vpcSettings :: Lens' CreateDirectory (Maybe DirectoryVpcSettings) Source #
A DirectoryVpcSettings object that contains additional information for the operation.
createDirectory_description :: Lens' CreateDirectory (Maybe Text) Source #
A description for the directory.
createDirectory_tags :: Lens' CreateDirectory (Maybe [Tag]) Source #
The tags to be assigned to the Simple AD directory.
createDirectory_name :: Lens' CreateDirectory Text Source #
The fully qualified name for the directory, such as corp.example.com.
createDirectory_password :: Lens' CreateDirectory Text Source #
The password for the directory administrator. The directory creation
process creates a directory administrator account with the user name
Administrator and this password.
If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
The regex pattern for this string is made up of the following conditions:
- Length (?=^.{8,64}$) – Must be between 8 and 64 characters
AND any 3 of the following password complexity rules required by Active Directory:
- Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
- Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
- Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
- Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])
For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
createDirectory_size :: Lens' CreateDirectory DirectorySize Source #
The size of the directory.
Destructuring the Response
data CreateDirectoryResponse Source #
Contains the results of the CreateDirectory operation.
See: newCreateDirectoryResponse smart constructor.
Constructors
| CreateDirectoryResponse' | |
Fields
| |
Instances
newCreateDirectoryResponse Source #
Create a value of CreateDirectoryResponse 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:CreateDirectoryResponse', createDirectoryResponse_directoryId - The identifier of the directory that was created.
$sel:httpStatus:CreateDirectoryResponse', createDirectoryResponse_httpStatus - The response's http status code.
Response Lenses
createDirectoryResponse_directoryId :: Lens' CreateDirectoryResponse (Maybe Text) Source #
The identifier of the directory that was created.
createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int Source #
The response's http status code.