Package software.amazon.awscdk.services.directoryservice

Class CfnSimpleAD.Builder

java.lang.Object

software.amazon.awscdk.services.directoryservice.CfnSimpleAD.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSimpleAD>

Enclosing class:

CfnSimpleAD

@Stability(Stable)
public static final class CfnSimpleAD.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSimpleAD>

A fluent builder for CfnSimpleAD.

Method Summary

Modifier and Type	Method	Description
CfnSimpleAD	build()
static CfnSimpleAD.Builder	create(software.constructs.Construct scope, String id)
CfnSimpleAD.Builder	createAlias(Boolean createAlias)	If set to true , specifies an alias for a directory and assigns the alias to the directory.
CfnSimpleAD.Builder	createAlias(IResolvable createAlias)	If set to true , specifies an alias for a directory and assigns the alias to the directory.
CfnSimpleAD.Builder	description(String description)	A description for the directory.
CfnSimpleAD.Builder	enableSso(Boolean enableSso)	Whether to enable single sign-on for a directory.
CfnSimpleAD.Builder	enableSso(IResolvable enableSso)	Whether to enable single sign-on for a directory.
CfnSimpleAD.Builder	name(String name)	The fully qualified name for the directory, such as corp.example.com .
CfnSimpleAD.Builder	password(String password)	The password for the directory administrator.
CfnSimpleAD.Builder	shortName(String shortName)	The NetBIOS name of the directory, such as CORP .
CfnSimpleAD.Builder	size(String size)	The size of the directory.
CfnSimpleAD.Builder	vpcSettings(IResolvable vpcSettings)	A DirectoryVpcSettings object that contains additional information for the operation.
CfnSimpleAD.Builder	vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings)	A DirectoryVpcSettings object that contains additional information for the operation.

Methods inherited from class java.lang.Object

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

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

@Stability(Stable)
public CfnSimpleAD.Builder name(String name)

The fully qualified name for the directory, such as corp.example.com .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name

size

@Stability(Stable)
public CfnSimpleAD.Builder size(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size

vpcSettings

@Stability(Stable)
public CfnSimpleAD.Builder vpcSettings(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings

createAlias

@Stability(Stable)
public CfnSimpleAD.Builder createAlias(Boolean 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.

Parameters:

createAlias - If set to true , specifies an alias for a directory and assigns the alias to the directory. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias

createAlias

@Stability(Stable)
public CfnSimpleAD.Builder createAlias(IResolvable 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.

Parameters:

createAlias - If set to true , specifies an alias for a directory and assigns the alias to the directory. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias

description

@Stability(Stable)
public CfnSimpleAD.Builder description(String description)

A description for the directory.

Parameters:

description - A description for the directory. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description

enableSso

@Stability(Stable)
public CfnSimpleAD.Builder enableSso(Boolean 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso

enableSso

@Stability(Stable)
public CfnSimpleAD.Builder enableSso(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso

password

@Stability(Stable)
public CfnSimpleAD.Builder password(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password

shortName

@Stability(Stable)
public CfnSimpleAD.Builder shortName(String shortName)

The NetBIOS name of the directory, such as CORP .

Parameters:

shortName - The NetBIOS name of the directory, such as CORP . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname

build

@Stability(Stable)
public CfnSimpleAD build()

Specified by:

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

Returns:

a newly built instance of CfnSimpleAD.