Class CfnMicrosoftADProps.Builder
java.lang.Object
software.amazon.awscdk.services.directoryservice.CfnMicrosoftADProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMicrosoftADProps>
- Enclosing interface:
CfnMicrosoftADProps
@Stability(Stable)
public static final class CfnMicrosoftADProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMicrosoftADProps>
A builder for
CfnMicrosoftADProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.createAlias
(Boolean createAlias) Sets the value ofCfnMicrosoftADProps.getCreateAlias()
createAlias
(IResolvable createAlias) Sets the value ofCfnMicrosoftADProps.getCreateAlias()
Sets the value ofCfnMicrosoftADProps.getEdition()
Sets the value ofCfnMicrosoftADProps.getEnableSso()
enableSso
(IResolvable enableSso) Sets the value ofCfnMicrosoftADProps.getEnableSso()
Sets the value ofCfnMicrosoftADProps.getName()
Sets the value ofCfnMicrosoftADProps.getPassword()
Sets the value ofCfnMicrosoftADProps.getShortName()
vpcSettings
(IResolvable vpcSettings) Sets the value ofCfnMicrosoftADProps.getVpcSettings()
vpcSettings
(CfnMicrosoftAD.VpcSettingsProperty vpcSettings) Sets the value ofCfnMicrosoftADProps.getVpcSettings()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnMicrosoftADProps.getName()
- 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
Sets the value ofCfnMicrosoftADProps.getPassword()
- Parameters:
password
- The password for the default administrative user namedAdmin
. This parameter is required. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .- Returns:
this
-
vpcSettings
@Stability(Stable) public CfnMicrosoftADProps.Builder vpcSettings(CfnMicrosoftAD.VpcSettingsProperty vpcSettings) Sets the value ofCfnMicrosoftADProps.getVpcSettings()
- Parameters:
vpcSettings
- Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.- Returns:
this
-
vpcSettings
Sets the value ofCfnMicrosoftADProps.getVpcSettings()
- Parameters:
vpcSettings
- Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.- Returns:
this
-
createAlias
Sets the value ofCfnMicrosoftADProps.getCreateAlias()
- Parameters:
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 ashttp://<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.
- Returns:
this
-
createAlias
Sets the value ofCfnMicrosoftADProps.getCreateAlias()
- Parameters:
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 ashttp://<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.
- Returns:
this
-
edition
Sets the value ofCfnMicrosoftADProps.getEdition()
- Parameters:
edition
- AWS Managed Microsoft AD is available in two editions:Standard
andEnterprise
.Enterprise
is the default.- Returns:
this
-
enableSso
Sets the value ofCfnMicrosoftADProps.getEnableSso()
- Parameters:
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.- Returns:
this
-
enableSso
Sets the value ofCfnMicrosoftADProps.getEnableSso()
- Parameters:
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.- Returns:
this
-
shortName
Sets the value ofCfnMicrosoftADProps.getShortName()
- Parameters:
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
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMicrosoftADProps>
- Returns:
- a new instance of
CfnMicrosoftADProps
- Throws:
NullPointerException
- if any required attribute was not provided
-