Class CfnSimpleAD
A CloudFormation AWS::DirectoryService::SimpleAD
.
Inherited Members
Namespace: Amazon.CDK.AWS.DirectoryService
Assembly: Amazon.CDK.AWS.DirectoryService.dll
Syntax (csharp)
public class CfnSimpleAD : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSimpleAD
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DirectoryService::SimpleAD
resource specifies an AWS Directory Service Simple Active Directory ( Simple AD ) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. Simple AD is a Microsoft Active Directory–compatible directory. For more information, see Simple Active Directory in the AWS Directory Service Admin Guide .
CloudformationResource: AWS::DirectoryService::SimpleAD
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 cfnSimpleAD = new CfnSimpleAD(this, "MyCfnSimpleAD", 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
Constructors
CfnSimpleAD(Construct, String, ICfnSimpleADProps) | Create a new |
CfnSimpleAD(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSimpleAD(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrAlias | The alias for a directory. |
AttrDirectoryId | |
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 | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSimpleAD(Construct, String, ICfnSimpleADProps)
Create a new AWS::DirectoryService::SimpleAD
.
public CfnSimpleAD(Construct scope, string id, ICfnSimpleADProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSimpleADProps
- resource properties.
CfnSimpleAD(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSimpleAD(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSimpleAD(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSimpleAD(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
AttrDirectoryId
public virtual string AttrDirectoryId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DirectoryId
AttrDnsIpAddresses
The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ]
.
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
If set to true
, 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, 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.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EnableSso
Whether to enable single sign-on for a directory.
public virtual object EnableSso { get; set; }
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
.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Password
The password for the directory administrator.
public virtual string Password { get; set; }
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
.
public virtual string ShortName { get; set; }
Property Value
System.String
Remarks
Size
The size of the directory.
public virtual string Size { get; set; }
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.
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>