Class CfnSimpleADProps.Builder
java.lang.Object
software.amazon.awscdk.services.directoryservice.CfnSimpleADProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSimpleADProps>
- Enclosing interface:
CfnSimpleADProps
@Stability(Stable)
public static final class CfnSimpleADProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSimpleADProps>
A builder for
CfnSimpleADProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.createAlias
(Boolean createAlias) Sets the value ofCfnSimpleADProps.getCreateAlias()
createAlias
(IResolvable createAlias) Sets the value ofCfnSimpleADProps.getCreateAlias()
description
(String description) Sets the value ofCfnSimpleADProps.getDescription()
Sets the value ofCfnSimpleADProps.getEnableSso()
enableSso
(IResolvable enableSso) Sets the value ofCfnSimpleADProps.getEnableSso()
Sets the value ofCfnSimpleADProps.getName()
Sets the value ofCfnSimpleADProps.getPassword()
Sets the value ofCfnSimpleADProps.getShortName()
Sets the value ofCfnSimpleADProps.getSize()
vpcSettings
(IResolvable vpcSettings) Sets the value ofCfnSimpleADProps.getVpcSettings()
vpcSettings
(CfnSimpleAD.VpcSettingsProperty vpcSettings) Sets the value ofCfnSimpleADProps.getVpcSettings()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnSimpleADProps.getName()
- Parameters:
name
- The fully qualified name for the directory, such ascorp.example.com
. This parameter is required.- Returns:
this
-
size
Sets the value ofCfnSimpleADProps.getSize()
- Parameters:
size
- The size of the directory. This parameter is required. For valid values, see CreateDirectory in the AWS Directory Service API Reference .- Returns:
this
-
vpcSettings
Sets the value ofCfnSimpleADProps.getVpcSettings()
- Parameters:
vpcSettings
- A DirectoryVpcSettings object that contains additional information for the operation. This parameter is required.- Returns:
this
-
vpcSettings
@Stability(Stable) public CfnSimpleADProps.Builder vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings) Sets the value ofCfnSimpleADProps.getVpcSettings()
- Parameters:
vpcSettings
- A DirectoryVpcSettings object that contains additional information for the operation. This parameter is required.- Returns:
this
-
createAlias
Sets the value ofCfnSimpleADProps.getCreateAlias()
- Parameters:
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 ashttp://<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.
- Returns:
this
-
createAlias
Sets the value ofCfnSimpleADProps.getCreateAlias()
- Parameters:
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 ashttp://<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.
- Returns:
this
-
description
Sets the value ofCfnSimpleADProps.getDescription()
- Parameters:
description
- A description for the directory.- Returns:
this
-
enableSso
Sets the value ofCfnSimpleADProps.getEnableSso()
- Parameters:
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.- Returns:
this
-
enableSso
Sets the value ofCfnSimpleADProps.getEnableSso()
- Parameters:
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.- Returns:
this
-
password
Sets the value ofCfnSimpleADProps.getPassword()
- Parameters:
password
- 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 .
- Returns:
this
-
shortName
Sets the value ofCfnSimpleADProps.getShortName()
- Parameters:
shortName
- The NetBIOS name of the directory, such asCORP
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnSimpleADProps>
- Returns:
- a new instance of
CfnSimpleADProps
- Throws:
NullPointerException
- if any required attribute was not provided
-