L1 ConstructAWS::DirectoryService::SimpleAD

CfnSimpleAD

The `AWS::DirectoryService::SimpleAD` resource specifies an 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](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *Directory Service Admin Guide* .

Import

import { CfnSimpleAD } from 'aws-cdk-lib/aws-directoryservice';

Or use the module namespace:

import * as directoryservice from 'aws-cdk-lib/aws-directoryservice';
// directoryservice.CfnSimpleAD

Properties

Configuration passed to the constructor as CfnSimpleADProps.

nameRequired

string

The fully qualified name for the directory, such as `corp.example.com` .

sizeRequired

string

The size of the directory. For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *Directory Service API Reference* .

vpcSettingsRequired

IResolvable | VpcSettingsProperty

A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.

createAliasOptional

boolean | IResolvable

If set to `true` , specifies an alias for a directory and assigns the alias to the directory. 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.

descriptionOptional

string

A description for the directory.

enableSsoOptional

boolean | IResolvable

Whether to enable single sign-on for a directory. If you don't specify a value, CloudFormation disables single sign-on by default.

passwordOptional

string

The password for the directory administrator. 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](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference* .

shortNameOptional

string

The NetBIOS name of the directory, such as `CORP` .

tagsOptional

CfnTag[]