Skip to content

CreateDirectoryRequest

Source code in docs_src/capo_directory_service/types/create_directory_request.py
class CreateDirectoryRequest(TypedDict, closed=True):
    name: "capo_directory_service.types.directory_name.DirectoryName"
    """<p>The fully qualified name for the directory, such as <code>corp.example.com</code>.</p>"""
    short_name: NotRequired[
        "capo_directory_service.types.directory_short_name.DirectoryShortName"
    ]
    """<p>The NetBIOS name of the directory, such as <code>CORP</code>.</p>"""
    password: "capo_directory_service.types.password.Password"
    r"""<p>The password for the directory administrator. The directory creation process creates a directory administrator account with the user name <code>Administrator</code> and this password.</p> <p>If you need to change the password for the administrator account, you can use the <a>ResetUserPassword</a> API call.</p> <p>The regex pattern for this string is made up of the following conditions:</p> <ul> <li> <p>Length (?=^.{8,64}$) – Must be between 8 and 64 characters</p> </li> </ul> <p>AND any 3 of the following password complexity rules required by Active Directory:</p> <ul> <li> <p>Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])</p> </li> <li> <p>Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])</p> </li> <li> <p>Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])</p> </li> <li> <p>Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])</p> </li> </ul> <p>For additional information about how Active Directory passwords are enforced, see <a href="https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements">Password must meet complexity requirements</a> on the Microsoft website.</p>"""
    description: NotRequired["capo_directory_service.types.description.Description"]
    """<p>A description for the directory.</p>"""
    size: "capo_directory_service.types.directory_size.DirectorySize"
    """<p>The size of the directory.</p>"""
    vpc_settings: NotRequired[
        "capo_directory_service.types.directory_vpc_settings.DirectoryVpcSettings"
    ]
    """<p>A <a>DirectoryVpcSettings</a> object that contains additional information for the operation.</p>"""
    tags: NotRequired["capo_directory_service.types.tags.Tags"]
    """<p>The tags to be assigned to the Simple AD directory.</p>"""
    network_type: NotRequired["capo_directory_service.types.network_type.NetworkType"]
    """<p>The network type for your directory. Simple AD supports IPv4 and Dual-stack only.</p>"""

description instance-attribute

description: NotRequired[Description]

A description for the directory.

name instance-attribute

The fully qualified name for the directory, such as corp.example.com.

network_type instance-attribute

network_type: NotRequired[NetworkType]

The network type for your directory. Simple AD supports IPv4 and Dual-stack only.

password instance-attribute

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

short_name instance-attribute

short_name: NotRequired[DirectoryShortName]

The NetBIOS name of the directory, such as CORP.

size instance-attribute

The size of the directory.

tags instance-attribute

tags: NotRequired[Tags]

The tags to be assigned to the Simple AD directory.

vpc_settings instance-attribute

vpc_settings: NotRequired[DirectoryVpcSettings]

A DirectoryVpcSettings object that contains additional information for the operation.