CfnMicrosoftADProps

class aws_cdk.aws_directoryservice.CfnMicrosoftADProps(*, name, password, vpc_settings, create_alias=None, edition=None, enable_sso=None, short_name=None)

Bases: object

Properties for defining a CfnMicrosoftAD.

Parameters:

  • name (str) – The fully qualified domain name for the AWS 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.

  • password (str) – The password for the default administrative user named Admin . If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .

  • vpc_settings (Union[IResolvable, VpcSettingsProperty, Dict[str, Any]]) – Specifies the VPC settings of the Microsoft AD directory server in AWS .

  • create_alias (Union[bool, IResolvable, None]) – Specifies an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com . By default, AWS CloudFormation does not create an alias. .. epigraph:: After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

  • edition (Optional[str]) – AWS Managed Microsoft AD is available in two editions: Standard and Enterprise . Enterprise is the default.

  • enable_sso (Union[bool, IResolvable, None]) – Whether to enable single sign-on for a Microsoft Active Directory in AWS . Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don’t specify a value, AWS CloudFormation disables single sign-on by default.

  • short_name (Optional[str]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_directoryservice as directoryservice

cfn_microsoft_aDProps = directoryservice.CfnMicrosoftADProps(
    name="name",
    password="password",
    vpc_settings=directoryservice.CfnMicrosoftAD.VpcSettingsProperty(
        subnet_ids=["subnetIds"],
        vpc_id="vpcId"
    ),

    # the properties below are optional
    create_alias=False,
    edition="edition",
    enable_sso=False,
    short_name="shortName"
)

Attributes

create_alias

Specifies an alias for a directory and assigns the alias to the directory.

The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com . By default, AWS CloudFormation does not create an alias. .. epigraph:

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias

edition

Standard and Enterprise .

Enterprise is the default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition

Type:

AWS Managed Microsoft AD is available in two editions

enable_sso

Whether to enable single sign-on for a Microsoft Active Directory in AWS .

Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don’t specify a value, AWS CloudFormation disables single sign-on by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso

name

The fully qualified domain name for the AWS 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name

password

The password for the default administrative user named Admin .

If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password

short_name

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname

vpc_settings

Specifies the VPC settings of the Microsoft AD directory server in AWS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings