Package software.amazon.awscdk.cfnpropertymixins.services.directoryservice

Class CfnSimpleADPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.directoryservice.CfnSimpleADPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSimpleADPropsMixin>

Enclosing class:

CfnSimpleADPropsMixin

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

A fluent builder for CfnSimpleADPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSimpleADPropsMixin	build()
static CfnSimpleADPropsMixin.Builder	create()
static CfnSimpleADPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSimpleADPropsMixin.Builder	createAlias(Boolean createAlias)	If set to true , specifies an alias for a directory and assigns the alias to the directory.
CfnSimpleADPropsMixin.Builder	createAlias(IResolvable createAlias)	If set to true , specifies an alias for a directory and assigns the alias to the directory.
CfnSimpleADPropsMixin.Builder	description(String description)	A description for the directory.
CfnSimpleADPropsMixin.Builder	enableSso(Boolean enableSso)	Whether to enable single sign-on for a directory.
CfnSimpleADPropsMixin.Builder	enableSso(IResolvable enableSso)	Whether to enable single sign-on for a directory.
CfnSimpleADPropsMixin.Builder	name(String name)	The fully qualified name for the directory, such as corp.example.com .
CfnSimpleADPropsMixin.Builder	password(String password)	The password for the directory administrator.
CfnSimpleADPropsMixin.Builder	shortName(String shortName)	The NetBIOS name of the directory, such as CORP .
CfnSimpleADPropsMixin.Builder	size(String size)	The size of the directory.
CfnSimpleADPropsMixin.Builder	tags(List<? extends CfnTag> tags)
CfnSimpleADPropsMixin.Builder	vpcSettings(CfnSimpleADPropsMixin.VpcSettingsProperty vpcSettings)	A DirectoryVpcSettings object that contains additional information for the operation.
CfnSimpleADPropsMixin.Builder	vpcSettings(IResolvable 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 CfnSimpleADPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSimpleADPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSimpleADPropsMixin.Builder create()

Returns:

a new instance of CfnSimpleADPropsMixin.Builder.

createAlias

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

Whether to enable single sign-on for a directory.

If you don't specify a value, 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 CfnSimpleADPropsMixin.Builder enableSso(IResolvable enableSso)

Whether to enable single sign-on for a directory.

If you don't specify a value, 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

name

@Stability(Stable)
public CfnSimpleADPropsMixin.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

password

@Stability(Stable)
public CfnSimpleADPropsMixin.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 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 CfnSimpleADPropsMixin.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

size

@Stability(Stable)
public CfnSimpleADPropsMixin.Builder size(String size)

The size of the directory.

For valid values, see CreateDirectory in the 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

tags

@Stability(Stable)
public CfnSimpleADPropsMixin.Builder tags(List<? extends CfnTag> tags)

Parameters:

tags - This parameter is required.

Returns:

this

See Also:

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

vpcSettings

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

build

@Stability(Stable)
public CfnSimpleADPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnSimpleADPropsMixin.