CfnSimpleADProps
- class aws_cdk.aws_directoryservice.CfnSimpleADProps(*, name, size, vpc_settings, create_alias=None, description=None, enable_sso=None, password=None, short_name=None)
Bases:
object
Properties for defining a
CfnSimpleAD
.- Parameters:
name (
str
) – The fully qualified name for the directory, such ascorp.example.com
.size (
str
) – The size of the directory. For valid values, see CreateDirectory in the AWS Directory Service API Reference .vpc_settings (
Union
[IResolvable
,VpcSettingsProperty
,Dict
[str
,Any
]]) – A DirectoryVpcSettings object that contains additional information for the operation.create_alias (
Union
[bool
,IResolvable
,None
]) – If set totrue
, 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 ashttp://<alias>.awsapps.com
. By default, this property is set tofalse
. .. 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, AWS CloudFormation disables single sign-on by default.password (
Optional
[str
]) – The password for the directory administrator. The directory creation process creates a directory administrator account with the user nameAdministrator
and this password. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .short_name (
Optional
[str
]) – The NetBIOS name of the directory, such asCORP
.
- See:
- 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_simple_aDProps = directoryservice.CfnSimpleADProps( name="name", size="size", vpc_settings=directoryservice.CfnSimpleAD.VpcSettingsProperty( subnet_ids=["subnetIds"], vpc_id="vpcId" ), # the properties below are optional create_alias=False, description="description", enable_sso=False, password="password", short_name="shortName" )
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 tofalse
. .. epigraph:After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- description
A description for the directory.
- enable_sso
Whether to enable single sign-on for a directory.
If you don’t specify a value, AWS CloudFormation disables single sign-on by default.
- name
The fully qualified name for the directory, such as
corp.example.com
.
- 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 AWS Directory Service API Reference .
- short_name
The NetBIOS name of the directory, such as
CORP
.
- size
The size of the directory.
For valid values, see CreateDirectory in the AWS Directory Service API Reference .