Class CfnMicrosoftAD.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMicrosoftAD>
- Enclosing class:
CfnMicrosoftAD
CfnMicrosoftAD
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnMicrosoftAD.Builder
createAlias
(Boolean createAlias) Specifies an alias for a directory and assigns the alias to the directory.createAlias
(IResolvable createAlias) Specifies an alias for a directory and assigns the alias to the directory.AWS Managed Microsoft AD is available in two editions:Standard
andEnterprise
.Whether to enable single sign-on for a Microsoft Active Directory in AWS .enableSso
(IResolvable enableSso) Whether to enable single sign-on for a Microsoft Active Directory in AWS .The fully qualified domain name for the AWS Managed Microsoft AD directory, such ascorp.example.com
.The password for the default administrative user namedAdmin
.The NetBIOS name for your domain, such asCORP
.vpcSettings
(IResolvable vpcSettings) Specifies the VPC settings of the Microsoft AD directory server in AWS .vpcSettings
(CfnMicrosoftAD.VpcSettingsProperty vpcSettings) Specifies the VPC settings of the Microsoft AD directory server in AWS .
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnMicrosoftAD.Builder
.
-
name
The fully qualified domain name for the AWS Managed Microsoft AD directory, such ascorp.example.com
. This name will resolve inside your VPC only. It does not need to be publicly resolvable.- Parameters:
name
- The fully qualified domain name for the AWS Managed Microsoft AD directory, such ascorp.example.com
. This name will resolve inside your VPC only. It does not need to be publicly resolvable. This parameter is required.- Returns:
this
-
password
The password for the default administrative user namedAdmin
.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 default administrative user namedAdmin
. This parameter is required.- Returns:
this
-
vpcSettings
@Stability(Stable) public CfnMicrosoftAD.Builder vpcSettings(CfnMicrosoftAD.VpcSettingsProperty vpcSettings) Specifies the VPC settings of the Microsoft AD directory server in AWS .- Parameters:
vpcSettings
- Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.- Returns:
this
-
vpcSettings
Specifies the VPC settings of the Microsoft AD directory server in AWS .- Parameters:
vpcSettings
- Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.- Returns:
this
-
createAlias
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.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAlias
- Specifies an alias for a directory and assigns the alias to the directory. This parameter is required.- Returns:
this
-
createAlias
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.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAlias
- Specifies an alias for a directory and assigns the alias to the directory. This parameter is required.- Returns:
this
-
edition
AWS Managed Microsoft AD is available in two editions:Standard
andEnterprise
.Enterprise
is the default.- Parameters:
edition
- AWS Managed Microsoft AD is available in two editions:Standard
andEnterprise
. This parameter is required.- Returns:
this
-
enableSso
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.
- Parameters:
enableSso
- Whether to enable single sign-on for a Microsoft Active Directory in AWS . This parameter is required.- Returns:
this
-
enableSso
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.
- Parameters:
enableSso
- Whether to enable single sign-on for a Microsoft Active Directory in AWS . This parameter is required.- Returns:
this
-
shortName
The NetBIOS name for your domain, such asCORP
.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 DNScorp.example.com
.- Parameters:
shortName
- The NetBIOS name for your domain, such asCORP
. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMicrosoftAD>
- Returns:
- a newly built instance of
CfnMicrosoftAD
.
-