software.amazon.awscdk.services.directoryservice

Class CfnMicrosoftAD

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.directoryservice.CfnMicrosoftAD

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.925Z")
 @Stability(value=Stable)
public class CfnMicrosoftAD
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DirectoryService::MicrosoftAD`.

The AWS::DirectoryService::MicrosoftAD resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide .

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.*;
 CfnMicrosoftAD cfnMicrosoftAD = CfnMicrosoftAD.Builder.create(this, "MyCfnMicrosoftAD")
         .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	Class and Description
static class	CfnMicrosoftAD.Builder A fluent builder for CfnMicrosoftAD.
static interface	CfnMicrosoftAD.VpcSettingsProperty Contains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html) operation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMicrosoftAD(software.constructs.Construct scope, String id, CfnMicrosoftADProps props) Create a new `AWS::DirectoryService::MicrosoftAD`.
protected	CfnMicrosoftAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMicrosoftAD(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAlias() The alias for a directory.
List<String>	getAttrDnsIpAddresses() The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]` .
protected Map<String,Object>	getCfnProperties()
Object	getCreateAlias() Specifies an alias for a directory and assigns the alias to the directory.
String	getEdition() AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
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` .
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 .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCreateAlias(Boolean value) Specifies an alias for a directory and assigns the alias to the directory.
void	setCreateAlias(IResolvable value) Specifies an alias for a directory and assigns the alias to the directory.
void	setEdition(String value) AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
void	setEnableSso(Boolean value) Whether to enable single sign-on for a Microsoft Active Directory in AWS .
void	setEnableSso(IResolvable value) Whether to enable single sign-on for a Microsoft Active Directory in AWS .
void	setName(String value) The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` .
void	setPassword(String value) The password for the default administrative user named `Admin` .
void	setShortName(String value) The NetBIOS name for your domain, such as `CORP` .
void	setVpcSettings(CfnMicrosoftAD.VpcSettingsProperty value) Specifies the VPC settings of the Microsoft AD directory server in AWS .
void	setVpcSettings(IResolvable value) Specifies the VPC settings of the Microsoft AD directory server in AWS .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMicrosoftAD

protected CfnMicrosoftAD(software.amazon.jsii.JsiiObjectRef objRef)

CfnMicrosoftAD

protected CfnMicrosoftAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMicrosoftAD

@Stability(value=Stable)
public CfnMicrosoftAD(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnMicrosoftADProps props)

Create a new `AWS::DirectoryService::MicrosoftAD`.

Parameters:

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

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

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAlias

@Stability(value=Stable)
 @NotNull
public String getAttrAlias()

The alias for a directory.

For example: d-12373a053a or alias4-mydirectory-12345abcgmzsk (if you have the CreateAlias property set to true).

getAttrDnsIpAddresses

@Stability(value=Stable)
 @NotNull
public List<String> getAttrDnsIpAddresses()

The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public 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.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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(value=Stable)
 @NotNull
public 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 .

setPassword

@Stability(value=Stable)
public void setPassword(@NotNull
                                                 String value)

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(value=Stable)
 @NotNull
public Object getVpcSettings()

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

setVpcSettings

@Stability(value=Stable)
public void setVpcSettings(@NotNull
                                                    CfnMicrosoftAD.VpcSettingsProperty value)

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

setVpcSettings

@Stability(value=Stable)
public void setVpcSettings(@NotNull
                                                    IResolvable value)

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

getCreateAlias

@Stability(value=Stable)
 @Nullable
public 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.

setCreateAlias

@Stability(value=Stable)
public void setCreateAlias(@Nullable
                                                    Boolean value)

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.

setCreateAlias

@Stability(value=Stable)
public void setCreateAlias(@Nullable
                                                    IResolvable value)

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(value=Stable)
 @Nullable
public String getEdition()

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

Enterprise is the default.

setEdition

@Stability(value=Stable)
public void setEdition(@Nullable
                                                String value)

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

Enterprise is the default.

getEnableSso

@Stability(value=Stable)
 @Nullable
public 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.

setEnableSso

@Stability(value=Stable)
public void setEnableSso(@Nullable
                                                  Boolean value)

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.

setEnableSso

@Stability(value=Stable)
public void setEnableSso(@Nullable
                                                  IResolvable value)

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(value=Stable)
 @Nullable
public 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 .

setShortName

@Stability(value=Stable)
public void setShortName(@Nullable
                                                  String value)

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 .