software.amazon.awscdk.services.directoryservice

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(value=Stable)
public static final class CfnSimpleADProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSimpleADProps>

A builder for CfnSimpleADProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnSimpleADProps	build() Builds the configured instance.
CfnSimpleADProps.Builder	createAlias(Boolean createAlias) Sets the value of CfnSimpleADProps.getCreateAlias()
CfnSimpleADProps.Builder	createAlias(IResolvable createAlias) Sets the value of CfnSimpleADProps.getCreateAlias()
CfnSimpleADProps.Builder	description(String description) Sets the value of CfnSimpleADProps.getDescription()
CfnSimpleADProps.Builder	enableSso(Boolean enableSso) Sets the value of CfnSimpleADProps.getEnableSso()
CfnSimpleADProps.Builder	enableSso(IResolvable enableSso) Sets the value of CfnSimpleADProps.getEnableSso()
CfnSimpleADProps.Builder	name(String name) Sets the value of CfnSimpleADProps.getName()
CfnSimpleADProps.Builder	password(String password) Sets the value of CfnSimpleADProps.getPassword()
CfnSimpleADProps.Builder	shortName(String shortName) Sets the value of CfnSimpleADProps.getShortName()
CfnSimpleADProps.Builder	size(String size) Sets the value of CfnSimpleADProps.getSize()
CfnSimpleADProps.Builder	vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings) Sets the value of CfnSimpleADProps.getVpcSettings()
CfnSimpleADProps.Builder	vpcSettings(IResolvable vpcSettings) Sets the value of CfnSimpleADProps.getVpcSettings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(value=Stable)
public CfnSimpleADProps.Builder name(String name)

Sets the value of CfnSimpleADProps.getName()

Parameters:

name - The fully qualified name for the directory, such as `corp.example.com` . This parameter is required.

Returns:

this

password

@Stability(value=Stable)
public CfnSimpleADProps.Builder password(String password)

Sets the value of CfnSimpleADProps.getPassword()

Parameters:

password - The password for the directory administrator. This parameter is required. 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 .

Returns:

this

size

@Stability(value=Stable)
public CfnSimpleADProps.Builder size(String size)

Sets the value of CfnSimpleADProps.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

@Stability(value=Stable)
public CfnSimpleADProps.Builder vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings)

Sets the value of CfnSimpleADProps.getVpcSettings()

Parameters:

vpcSettings - A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation. This parameter is required.

Returns:

this

vpcSettings

@Stability(value=Stable)
public CfnSimpleADProps.Builder vpcSettings(IResolvable vpcSettings)

Sets the value of CfnSimpleADProps.getVpcSettings()

Parameters:

vpcSettings - A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation. This parameter is required.

Returns:

this

createAlias

@Stability(value=Stable)
public CfnSimpleADProps.Builder createAlias(Boolean createAlias)

Sets the value of CfnSimpleADProps.getCreateAlias()

Parameters:

createAlias - 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 to false .

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

@Stability(value=Stable)
public CfnSimpleADProps.Builder createAlias(IResolvable createAlias)

Sets the value of CfnSimpleADProps.getCreateAlias()

Parameters:

createAlias - 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 to false .

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

@Stability(value=Stable)
public CfnSimpleADProps.Builder description(String description)

Sets the value of CfnSimpleADProps.getDescription()

Parameters:

description - A description for the directory.

Returns:

this

enableSso

@Stability(value=Stable)
public CfnSimpleADProps.Builder enableSso(Boolean enableSso)

Sets the value of CfnSimpleADProps.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

@Stability(value=Stable)
public CfnSimpleADProps.Builder enableSso(IResolvable enableSso)

Sets the value of CfnSimpleADProps.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

shortName

@Stability(value=Stable)
public CfnSimpleADProps.Builder shortName(String shortName)

Sets the value of CfnSimpleADProps.getShortName()

Parameters:

shortName - The NetBIOS name of the directory, such as `CORP` .

Returns:

this

build

@Stability(value=Stable)
public CfnSimpleADProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSimpleADProps>

Returns:

a new instance of CfnSimpleADProps

Throws:

NullPointerException - if any required attribute was not provided