Package software.amazon.awscdk.services.directoryservice

Class CfnMicrosoftAD.Builder

java.lang.Object

software.amazon.awscdk.services.directoryservice.CfnMicrosoftAD.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMicrosoftAD>

Enclosing class:

CfnMicrosoftAD

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

A fluent builder for CfnMicrosoftAD.

Method Summary

Modifier and Type	Method	Description
CfnMicrosoftAD	build()
static CfnMicrosoftAD.Builder	create(software.constructs.Construct scope, String id)
CfnMicrosoftAD.Builder	createAlias(Boolean createAlias)	Specifies an alias for a directory and assigns the alias to the directory.
CfnMicrosoftAD.Builder	createAlias(IResolvable createAlias)	Specifies an alias for a directory and assigns the alias to the directory.
CfnMicrosoftAD.Builder	edition(String edition)	AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .
CfnMicrosoftAD.Builder	enableSso(Boolean enableSso)	Whether to enable single sign-on for a Microsoft Active Directory in AWS .
CfnMicrosoftAD.Builder	enableSso(IResolvable enableSso)	Whether to enable single sign-on for a Microsoft Active Directory in AWS .
CfnMicrosoftAD.Builder	name(String name)	The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com .
CfnMicrosoftAD.Builder	password(String password)	The password for the default administrative user named Admin .
CfnMicrosoftAD.Builder	shortName(String shortName)	The NetBIOS name for your domain, such as CORP .
CfnMicrosoftAD.Builder	vpcSettings(IResolvable vpcSettings)	Specifies the VPC settings of the Microsoft AD directory server in AWS .
CfnMicrosoftAD.Builder	vpcSettings(CfnMicrosoftAD.VpcSettingsProperty vpcSettings)	Specifies the VPC settings of the Microsoft AD directory server in AWS .

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 CfnMicrosoftAD.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 CfnMicrosoftAD.Builder.

name

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

The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable.

Parameters:

name - The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable. This parameter is required.

Returns:

this

See Also:

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

password

@Stability(Stable)
public CfnMicrosoftAD.Builder password(String password)

The password for the default administrative user named Admin .

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 default administrative user named Admin . This parameter is required.

Returns:

this

See Also:

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

vpcSettings

@Stability(Stable)
public CfnMicrosoftAD.Builder vpcSettings(IResolvable vpcSettings)

Specifies the VPC settings of the Microsoft AD directory server in AWS .

Parameters:

vpcSettings - Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.

Returns:

this

See Also:

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

vpcSettings

@Stability(Stable)
public CfnMicrosoftAD.Builder vpcSettings(CfnMicrosoftAD.VpcSettingsProperty vpcSettings)

Specifies the VPC settings of the Microsoft AD directory server in AWS .

Parameters:

vpcSettings - Specifies the VPC settings of the Microsoft AD directory server in AWS . This parameter is required.

Returns:

this

See Also:

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

createAlias

@Stability(Stable)
public CfnMicrosoftAD.Builder createAlias(Boolean createAlias)

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, AWS CloudFormation does not create an alias.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

Parameters:

createAlias - 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-microsoftad.html#cfn-directoryservice-microsoftad-createalias

createAlias

@Stability(Stable)
public CfnMicrosoftAD.Builder createAlias(IResolvable createAlias)

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, AWS CloudFormation does not create an alias.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

Parameters:

createAlias - 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-microsoftad.html#cfn-directoryservice-microsoftad-createalias

edition

@Stability(Stable)
public CfnMicrosoftAD.Builder edition(String edition)

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .

Enterprise is the default.

Parameters:

edition - AWS Managed Microsoft AD is available in two editions: Standard and Enterprise . This parameter is required.

Returns:

this

See Also:

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

enableSso

@Stability(Stable)
public CfnMicrosoftAD.Builder enableSso(Boolean enableSso)

Whether to enable single sign-on for a Microsoft Active Directory in AWS .

Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. 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 Microsoft Active Directory in AWS . This parameter is required.

Returns:

this

See Also:

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

enableSso

@Stability(Stable)
public CfnMicrosoftAD.Builder enableSso(IResolvable enableSso)

Whether to enable single sign-on for a Microsoft Active Directory in AWS .

Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. 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 Microsoft Active Directory in AWS . This parameter is required.

Returns:

this

See Also:

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

shortName

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

The NetBIOS name for your domain, such as CORP .

If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com .

Parameters:

shortName - The NetBIOS name for your domain, such as CORP . This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnMicrosoftAD build()

Specified by:

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

Returns:

a newly built instance of CfnMicrosoftAD.