Package software.amazon.awscdk.services.directoryservice

Interface CfnMicrosoftADProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMicrosoftADProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.257Z")
@Stability(Stable)
public interface CfnMicrosoftADProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMicrosoftAD.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.directoryservice.*;
 CfnMicrosoftADProps cfnMicrosoftADProps = CfnMicrosoftADProps.builder()
         .name("name")
         .password("password")
         .vpcSettings(VpcSettingsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 .vpcId("vpcId")
                 .build())
         // the properties below are optional
         .createAlias(false)
         .edition("edition")
         .enableSso(false)
         .shortName("shortName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMicrosoftADProps.Builder	A builder for CfnMicrosoftADProps
static final class	CfnMicrosoftADProps.Jsii$Proxy	An implementation for CfnMicrosoftADProps

Method Summary

Modifier and Type	Method	Description
static CfnMicrosoftADProps.Builder	builder()
default Object	getCreateAlias()	Specifies an alias for a directory and assigns the alias to the directory.
default String	getEdition()	AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .
default Object	getEnableSso()	Whether to enable single sign-on for a Microsoft Active Directory in AWS .
String	getName()	The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com .
String	getPassword()	The password for the default administrative user named Admin .
default String	getShortName()	The NetBIOS name for your domain, such as CORP .
Object	getVpcSettings()	Specifies the VPC settings of the Microsoft AD directory server in AWS .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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.

getPassword

@Stability(Stable)
@NotNull
String getPassword()

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 .

getVpcSettings

@Stability(Stable)
@NotNull
Object getVpcSettings()

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

getCreateAlias

@Stability(Stable)
@Nullable
default Object getCreateAlias()

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.

getEdition

@Stability(Stable)
@Nullable
default String getEdition()

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

Enterprise is the default.

getEnableSso

@Stability(Stable)
@Nullable
default Object getEnableSso()

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.

getShortName

@Stability(Stable)
@Nullable
default String getShortName()

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 .

builder

@Stability(Stable)
static CfnMicrosoftADProps.Builder builder()

Returns:

a CfnMicrosoftADProps.Builder of CfnMicrosoftADProps