Class CfnSimpleAD.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSimpleAD>
- Enclosing class:
CfnSimpleAD
CfnSimpleAD
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnSimpleAD.Builder
createAlias
(Boolean createAlias) If set totrue
, specifies an alias for a directory and assigns the alias to the directory.createAlias
(IResolvable createAlias) If set totrue
, specifies an alias for a directory and assigns the alias to the directory.description
(String description) A description for the directory.Whether to enable single sign-on for a directory.enableSso
(IResolvable enableSso) Whether to enable single sign-on for a directory.The fully qualified name for the directory, such ascorp.example.com
.The password for the directory administrator.The NetBIOS name of the directory, such asCORP
.The size of the directory.vpcSettings
(IResolvable vpcSettings) A DirectoryVpcSettings object that contains additional information for the operation.vpcSettings
(CfnSimpleAD.VpcSettingsProperty vpcSettings) A DirectoryVpcSettings object that contains additional information for the operation.
-
Method Details
-
create
@Stability(Stable) public static CfnSimpleAD.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnSimpleAD.Builder
.
-
name
The fully qualified name for the directory, such ascorp.example.com
.- Parameters:
name
- The fully qualified name for the directory, such ascorp.example.com
. This parameter is required.- Returns:
this
- See Also:
-
size
The size of the directory.For valid values, see CreateDirectory in the AWS Directory Service API Reference .
- Parameters:
size
- The size of the directory. This parameter is required.- Returns:
this
- See Also:
-
vpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.- Parameters:
vpcSettings
- A DirectoryVpcSettings object that contains additional information for the operation. This parameter is required.- Returns:
this
- See Also:
-
vpcSettings
@Stability(Stable) public CfnSimpleAD.Builder vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings) A DirectoryVpcSettings object that contains additional information for the operation.- Parameters:
vpcSettings
- A DirectoryVpcSettings object that contains additional information for the operation. This parameter is required.- Returns:
this
- See Also:
-
createAlias
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 as
http://<alias>.awsapps.com
. By default, this property is set tofalse
.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAlias
- If set totrue
, specifies an alias for a directory and assigns the alias to the directory. This parameter is required.- Returns:
this
- See Also:
-
createAlias
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 as
http://<alias>.awsapps.com
. By default, this property is set tofalse
.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAlias
- If set totrue
, specifies an alias for a directory and assigns the alias to the directory. This parameter is required.- Returns:
this
- See Also:
-
description
A description for the directory.- Parameters:
description
- A description for the directory. This parameter is required.- Returns:
this
- See Also:
-
enableSso
Whether to enable single sign-on for a directory.If you don't specify a value, AWS CloudFormation disables single sign-on by default.
- Parameters:
enableSso
- Whether to enable single sign-on for a directory. This parameter is required.- Returns:
this
- See Also:
-
enableSso
Whether to enable single sign-on for a directory.If you don't specify a value, AWS CloudFormation disables single sign-on by default.
- Parameters:
enableSso
- Whether to enable single sign-on for a directory. This parameter is required.- Returns:
this
- See Also:
-
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 .
- Parameters:
password
- The password for the directory administrator. This parameter is required.- Returns:
this
- See Also:
-
shortName
The NetBIOS name of the directory, such asCORP
.- Parameters:
shortName
- The NetBIOS name of the directory, such asCORP
. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnSimpleAD>
- Returns:
- a newly built instance of
CfnSimpleAD
.
-