Interface ICfnMicrosoftADProps
Properties for defining a CfnMicrosoftAD
.
Namespace: Amazon.CDK.AWS.DirectoryService
Assembly: Amazon.CDK.AWS.DirectoryService.dll
Syntax (csharp)
public interface ICfnMicrosoftADProps
Syntax (vb)
Public Interface ICfnMicrosoftADProps
Remarks
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 cfnMicrosoftADProps = 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
Properties
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 . |
Properties
CreateAlias
Specifies an alias for a directory and assigns the alias to the directory.
virtual object CreateAlias { get; }
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
.
virtual string Edition { get; }
Property Value
System.String
Remarks
EnableSso
Whether to enable single sign-on for a Microsoft Active Directory in AWS .
virtual object EnableSso { get; }
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.
string Name { get; }
Property Value
System.String
Remarks
Password
The password for the default administrative user named Admin
.
string Password { get; }
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
.
virtual string ShortName { get; }
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 .
object VpcSettings { get; }
Property Value
System.Object