CfnSimpleADMixinProps

class aws_cdk.mixins_preview.aws_directoryservice.mixins.CfnSimpleADMixinProps(*, create_alias=None, description=None, enable_sso=None, name=None, password=None, short_name=None, size=None, vpc_settings=None)

Bases: object

Properties for CfnSimpleADPropsMixin.

Parameters:

create_alias (Union[bool, IResolvable, None]) – If set to true , 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, this property is set to false . .. epigraph:: After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
description (Optional[str]) – A description for the directory.
enable_sso (Union[bool, IResolvable, None]) – Whether to enable single sign-on for a directory. If you don’t specify a value, CloudFormation disables single sign-on by default.
name (Optional[str]) – The fully qualified name for the directory, such as corp.example.com .
password (Optional[str]) – 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, see the ResetUserPassword API call in the Directory Service API Reference .
short_name (Optional[str]) – The NetBIOS name of the directory, such as CORP .
size (Optional[str]) – The size of the directory. For valid values, see CreateDirectory in the Directory Service API Reference .
vpc_settings (Union[IResolvable, VpcSettingsProperty, Dict[str, Any], None]) – A DirectoryVpcSettings object that contains additional information for the operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.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.mixins_preview.aws_directoryservice import mixins as directoryservice_mixins

cfn_simple_aDMixin_props = directoryservice_mixins.CfnSimpleADMixinProps(
    create_alias=False,
    description="description",
    enable_sso=False,
    name="name",
    password="password",
    short_name="shortName",
    size="size",
    vpc_settings=directoryservice_mixins.CfnSimpleADPropsMixin.VpcSettingsProperty(
        subnet_ids=["subnetIds"],
        vpc_id="vpcId"
    )
)

Attributes

create_alias

If set to true , 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, this property is set to false . .. 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-simplead.html#cfn-directoryservice-simplead-createalias

description

A description for the directory.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description

enable_sso

Whether to enable single sign-on for a directory.

If you don’t specify a value, CloudFormation disables single sign-on by default.

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

name

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

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

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, see the ResetUserPassword API call in the Directory Service API Reference .

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

short_name

The NetBIOS name of the directory, such as CORP .

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

size

The size of the directory.

For valid values, see CreateDirectory in the Directory Service API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size

vpc_settings

A DirectoryVpcSettings object that contains additional information for the operation.

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