@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:50.030Z") public class CfnMicrosoftAD extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnMicrosoftAD(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrAlias()
The alias for a directory.
|
java.util.List<java.lang.String> |
getAttrDnsIpAddresses()
The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getCreateAlias()
Specifies an alias for a directory and assigns the alias to the directory.
|
java.lang.String |
getEdition()
AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
|
java.lang.Object |
getEnableSso()
Whether to enable single sign-on for a Microsoft Active Directory in AWS .
|
java.lang.String |
getName()
The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` .
|
java.lang.String |
getPassword()
The password for the default administrative user named `Admin` .
|
java.lang.String |
getShortName()
The NetBIOS name for your domain, such as `CORP` .
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCreateAlias(java.lang.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(java.lang.String value)
AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
|
void |
setEnableSso(java.lang.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(java.lang.String value)
The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` .
|
void |
setPassword(java.lang.String value)
The password for the default administrative user named `Admin` .
|
void |
setShortName(java.lang.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 .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnMicrosoftAD(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnMicrosoftAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnMicrosoftAD(Construct scope, java.lang.String id, CfnMicrosoftADProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAlias()
For example: d-12373a053a
or alias4-mydirectory-12345abcgmzsk
(if you have the CreateAlias
property set to true).
public java.util.List<java.lang.String> getAttrDnsIpAddresses()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getPassword()
If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .
public void setPassword(java.lang.String value)
If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .
public java.lang.Object getVpcSettings()
public void setVpcSettings(CfnMicrosoftAD.VpcSettingsProperty value)
public void setVpcSettings(IResolvable value)
public java.lang.Object getCreateAlias()
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.
public void setCreateAlias(java.lang.Boolean value)
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.
public void setCreateAlias(IResolvable value)
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.
public java.lang.String getEdition()
Enterprise
is the default.
public void setEdition(java.lang.String value)
Enterprise
is the default.
public java.lang.Object getEnableSso()
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.
public void setEnableSso(java.lang.Boolean value)
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.
public void setEnableSso(IResolvable value)
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.
public java.lang.String getShortName()
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
.
public void setShortName(java.lang.String value)
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
.