Class CfnMicrosoftAD
A CloudFormation AWS::DirectoryService::MicrosoftAD
.
Inherited Members
Namespace: Amazon.CDK.AWS.DirectoryService
Assembly: Amazon.CDK.AWS.DirectoryService.dll
Syntax (csharp)
public class CfnMicrosoftAD : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMicrosoftAD
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::DirectoryService::MicrosoftAD
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DirectoryService;
var cfnMicrosoftAD = new CfnMicrosoftAD(this, "MyCfnMicrosoftAD", new CfnMicrosoftADProps {
Name = "name",
Password = "password",
VpcSettings = new VpcSettingsProperty {
SubnetIds = new [] { "subnetIds" },
VpcId = "vpcId"
},
// the properties below are optional
CreateAlias = false,
Edition = "edition",
EnableSso = false,
ShortName = "shortName"
});
Synopsis
Constructors
CfnMicrosoftAD(Construct, String, ICfnMicrosoftADProps) | Create a new |
CfnMicrosoftAD(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMicrosoftAD(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrAlias | The alias for a directory. |
AttrDnsIpAddresses | The IP addresses of the DNS servers for the directory, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CreateAlias | Specifies an alias for a directory and assigns the alias to the directory. |
Edition | AWS Managed Microsoft AD is available in two editions: |
EnableSso | Whether to enable single sign-on for a Microsoft Active Directory in AWS . |
Name | The fully qualified domain name for the AWS Managed Microsoft AD directory, such as |
Password | The password for the default administrative user named |
ShortName | The NetBIOS name for your domain, such as |
VpcSettings | Specifies the VPC settings of the Microsoft AD directory server in AWS . |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMicrosoftAD(Construct, String, ICfnMicrosoftADProps)
Create a new AWS::DirectoryService::MicrosoftAD
.
public CfnMicrosoftAD(Construct scope, string id, ICfnMicrosoftADProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMicrosoftADProps
- resource properties.
CfnMicrosoftAD(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMicrosoftAD(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMicrosoftAD(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMicrosoftAD(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrAlias
The alias for a directory.
public virtual string AttrAlias { get; }
Property Value
System.String
Remarks
For example: d-12373a053a
or alias4-mydirectory-12345abcgmzsk
(if you have the CreateAlias
property set to true).
CloudformationAttribute: Alias
AttrDnsIpAddresses
The IP addresses of the DNS servers for the directory, such as [ "192.0.2.1", "192.0.2.2" ]
.
public virtual string[] AttrDnsIpAddresses { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: DnsIpAddresses
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CreateAlias
Specifies an alias for a directory and assigns the alias to the directory.
public virtual object CreateAlias { get; set; }
Property Value
System.Object
Remarks
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.
Edition
AWS Managed Microsoft AD is available in two editions: Standard
and Enterprise
.
public virtual string Edition { get; set; }
Property Value
System.String
Remarks
EnableSso
Whether to enable single sign-on for a Microsoft Active Directory in AWS .
public virtual object EnableSso { get; set; }
Property Value
System.Object
Remarks
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.
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.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Password
The password for the default administrative user named Admin
.
public virtual string Password { get; set; }
Property Value
System.String
Remarks
If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .
ShortName
The NetBIOS name for your domain, such as CORP
.
public virtual string ShortName { get; set; }
Property Value
System.String
Remarks
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
.
VpcSettings
Specifies the VPC settings of the Microsoft AD directory server in AWS .
public virtual object VpcSettings { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>