Class CfnMicrosoftAD
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.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.DirectoryService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMicrosoftAD : CfnResource, IInspectable
Syntax (vb)
Public Class CfnMicrosoftAD
Inherits CfnResource
Implements IInspectable
Remarks
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(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 |
CfnMicrosoftAD(Construct, String, ICfnMicrosoftADProps) |
Properties
AttrAlias | The alias for a directory. |
AttrDnsIpAddresses | The IP addresses of the DNS servers for the directory, such as |
AttrId | |
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(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
CfnMicrosoftAD(Construct, String, ICfnMicrosoftADProps)
public CfnMicrosoftAD(Construct scope, string id, ICfnMicrosoftADProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMicrosoftADProps
Resource properties.
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
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Edition
AWS Managed Microsoft AD is available in two editions: Standard
and Enterprise
.
public virtual string Edition { get; set; }
Property Value
System.String
EnableSso
Whether to enable single sign-on for a Microsoft Active Directory in AWS .
public virtual object EnableSso { get; set; }
Property Value
System.Object
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
Password
The password for the default administrative user named Admin
.
public virtual string Password { get; set; }
Property Value
System.String
ShortName
The NetBIOS name for your domain, such as CORP
.
public virtual string ShortName { get; set; }
Property Value
System.String
VpcSettings
Specifies the VPC settings of the Microsoft AD directory server in AWS .
public virtual object VpcSettings { get; set; }
Property Value
System.Object
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>