DirectoryService / Client / create_directory

create_directory#

DirectoryService.Client.create_directory(**kwargs)#

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.

Request Syntax

response = client.create_directory(
    Name='string',
    ShortName='string',
    Password='string',
    Description='string',
    Size='Small'|'Large',
    VpcSettings={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Name (string) –
[REQUIRED]

The fully qualified name for the directory, such as corp.example.com.
ShortName (string) – The NetBIOS name of the directory, such as CORP.
Password (string) –
[REQUIRED]

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-9s])(?=.*[a-z])
- Special characters and upper case and lower case (?=.*[^A-Za-z0-9s])(?=.*[A-Z])(?=.*[a-z])
- Numbers and upper case and special characters (?=.*d)(?=.*[A-Z])(?=.*[^A-Za-z0-9s])
For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
Description (string) – A description for the directory.
Size (string) –
[REQUIRED]

The size of the directory.
VpcSettings (dict) –
A DirectoryVpcSettings object that contains additional information for the operation.
- VpcId (string) – [REQUIRED]
  
  The identifier of the VPC in which to create the directory.
- SubnetIds (list) – [REQUIRED]
  
  The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. Directory Service creates a directory server and a DNS server in each of these subnets.
  - (string) –
Tags (list) –
The tags to be assigned to the Simple AD directory.
- (dict) –
  
  Metadata assigned to a directory consisting of a key-value pair.
  - Key (string) – [REQUIRED]
    
    Required name of the tag. The string value can be Unicode characters and cannot be prefixed with “aws:”. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’, ‘:’, ‘@’(Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).
  - Value (string) – [REQUIRED]
    
    The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’, ‘:’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryId': 'string'
}

Response Structure

(dict) –

Contains the results of the CreateDirectory operation.
- DirectoryId (string) –
  
  The identifier of the directory that was created.

Exceptions

DirectoryService.Client.exceptions.DirectoryLimitExceededException
DirectoryService.Client.exceptions.InvalidParameterException
DirectoryService.Client.exceptions.ClientException
DirectoryService.Client.exceptions.ServiceException