Skip to content

CreateMicrosoftADRequest

Source code in docs_src/capo_directory_service/types/create_microsoft_ad_request.py
class CreateMicrosoftADRequest(TypedDict, closed=True):
    name: "capo_directory_service.types.directory_name.DirectoryName"
    """<p>The fully qualified domain name for the Managed Microsoft AD directory, such as <code>corp.example.com</code>. This name will resolve inside your VPC only. It does not need to be publicly resolvable.</p>"""
    short_name: NotRequired[
        "capo_directory_service.types.directory_short_name.DirectoryShortName"
    ]
    """<p>The NetBIOS name for your domain, such as <code>CORP</code>. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, <code>CORP</code> for the directory DNS <code>corp.example.com</code>. </p>"""
    password: "capo_directory_service.types.password.Password"
    """<p>The password for the default administrative user named <code>Admin</code>.</p> <p>If you need to change the password for the administrator account, you can use the <a>ResetUserPassword</a> API call.</p>"""
    description: NotRequired["capo_directory_service.types.description.Description"]
    """<p>A description for the directory. This label will appear on the Amazon Web Services console <code>Directory Details</code> page after the directory is created.</p>"""
    vpc_settings: (
        "capo_directory_service.types.directory_vpc_settings.DirectoryVpcSettings"
    )
    """<p>Contains VPC information for the <a>CreateDirectory</a> or <a>CreateMicrosoftAD</a> operation.</p>"""
    edition: NotRequired[
        "capo_directory_service.types.directory_edition.DirectoryEdition"
    ]
    """<p>Managed Microsoft AD is available in two editions: <code>Standard</code> and <code>Enterprise</code>. <code>Enterprise</code> is the default.</p>"""
    tags: NotRequired["capo_directory_service.types.tags.Tags"]
    """<p>The tags to be assigned to the Managed Microsoft AD directory.</p>"""
    network_type: NotRequired["capo_directory_service.types.network_type.NetworkType"]
    """<p> The network type for your domain. The default value is <code>IPv4</code> or <code>IPv6</code> based on the provided subnet capabilities.</p>"""

description instance-attribute

description: NotRequired[Description]

A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

edition instance-attribute

edition: NotRequired[DirectoryEdition]

Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

name instance-attribute

The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

network_type instance-attribute

network_type: NotRequired[NetworkType]

The network type for your domain. The default value is IPv4 or IPv6 based on the provided subnet capabilities.

password instance-attribute

password: Password

The password for the default administrative user named Admin.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

short_name instance-attribute

short_name: NotRequired[DirectoryShortName]

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

tags instance-attribute

tags: NotRequired[Tags]

The tags to be assigned to the Managed Microsoft AD directory.

vpc_settings instance-attribute

vpc_settings: DirectoryVpcSettings

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.