software.amazon.awscdk.services.directoryservice

Class CfnSimpleAD.Builder

java.lang.Object

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

Enclosing class:

CfnSimpleAD

public static final class CfnSimpleAD.Builder
extends java.lang.Object

A fluent builder for CfnSimpleAD.

Method Summary

Modifier and Type	Method and Description
CfnSimpleAD	build()
static CfnSimpleAD.Builder	create(Construct scope, java.lang.String id)
CfnSimpleAD.Builder	createAlias(java.lang.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(java.lang.String description) A description for the directory.
CfnSimpleAD.Builder	enableSso(java.lang.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(java.lang.String name) The fully qualified name for the directory, such as `corp.example.com` .
CfnSimpleAD.Builder	password(java.lang.String password) The password for the directory administrator.
CfnSimpleAD.Builder	shortName(java.lang.String shortName) The NetBIOS name of the directory, such as `CORP` .
CfnSimpleAD.Builder	size(java.lang.String size) The size of the directory.
CfnSimpleAD.Builder	vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings) A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
CfnSimpleAD.Builder	vpcSettings(IResolvable vpcSettings) A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) 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 Detail

create

public static CfnSimpleAD.Builder create(Construct scope,
                                         java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnSimpleAD.VpcSettingsProperty.Builder.

name

public CfnSimpleAD.Builder name(java.lang.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

size

public CfnSimpleAD.Builder size(java.lang.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

vpcSettings

public CfnSimpleAD.Builder vpcSettings(IResolvable vpcSettings)

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

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

public CfnSimpleAD.Builder vpcSettings(CfnSimpleAD.VpcSettingsProperty vpcSettings)

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

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

public CfnSimpleAD.Builder createAlias(java.lang.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

createAlias

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

description

public CfnSimpleAD.Builder description(java.lang.String description)

A description for the directory.

Parameters:

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

Returns:

this

enableSso

public CfnSimpleAD.Builder enableSso(java.lang.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

enableSso

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

password

public CfnSimpleAD.Builder password(java.lang.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

shortName

public CfnSimpleAD.Builder shortName(java.lang.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

build

public CfnSimpleAD build()