Interface ICfnSimpleADProps
Properties for defining a CfnSimpleAD
.
Namespace: Amazon.CDK.AWS.DirectoryService
Assembly: Amazon.CDK.AWS.DirectoryService.dll
Syntax (csharp)
public interface ICfnSimpleADProps
Syntax (vb)
Public Interface ICfnSimpleADProps
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 cfnSimpleADProps = new CfnSimpleADProps {
Name = "name",
Size = "size",
VpcSettings = new VpcSettingsProperty {
SubnetIds = new [] { "subnetIds" },
VpcId = "vpcId"
},
// the properties below are optional
CreateAlias = false,
Description = "description",
EnableSso = false,
Password = "password",
ShortName = "shortName"
};
Synopsis
Properties
CreateAlias | If set to |
Description | A description for the directory. |
EnableSso | Whether to enable single sign-on for a directory. |
Name | The fully qualified name for the directory, such as |
Password | The password for the directory administrator. |
ShortName | The NetBIOS name of the directory, such as |
Size | The size of the directory. |
VpcSettings | A DirectoryVpcSettings object that contains additional information for the operation. |
Properties
CreateAlias
If set to true
, 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, this property is set to false
.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
Description
A description for the directory.
virtual string Description { get; }
Property Value
System.String
Remarks
EnableSso
Whether to enable single sign-on for a directory.
virtual object EnableSso { get; }
Property Value
System.Object
Remarks
If you don't specify a value, AWS CloudFormation disables single sign-on by default.
Name
The fully qualified name for the directory, such as corp.example.com
.
string Name { get; }
Property Value
System.String
Remarks
Password
The password for the directory administrator.
virtual string Password { get; }
Property Value
System.String
Remarks
The directory creation process creates a directory administrator account with the user name Administrator
and this password.
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 of the directory, such as CORP
.
virtual string ShortName { get; }
Property Value
System.String
Remarks
Size
The size of the directory.
string Size { get; }
Property Value
System.String
Remarks
For valid values, see CreateDirectory in the AWS Directory Service API Reference .
VpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.
object VpcSettings { get; }
Property Value
System.Object