aws-cdk-lib.aws_directoryservice.CfnSimpleADProps

interface CfnSimpleADProps

LanguageType name
.NETAmazon.CDK.AWS.DirectoryService.CfnSimpleADProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdirectoryservice#CfnSimpleADProps
Javasoftware.amazon.awscdk.services.directoryservice.CfnSimpleADProps
Pythonaws_cdk.aws_directoryservice.CfnSimpleADProps
TypeScript aws-cdk-lib » aws_directoryservice » CfnSimpleADProps

Properties for defining a CfnSimpleAD.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_directoryservice as directoryservice } from 'aws-cdk-lib';
const cfnSimpleADProps: directoryservice.CfnSimpleADProps = {
  name: 'name',
  size: 'size',
  vpcSettings: {
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },

  // the properties below are optional
  createAlias: false,
  description: 'description',
  enableSso: false,
  password: 'password',
  shortName: 'shortName',
};

Properties

NameTypeDescription
namestringThe fully qualified name for the directory, such as corp.example.com .
sizestringThe size of the directory.
vpcSettingsIResolvable | VpcSettingsPropertyA DirectoryVpcSettings object that contains additional information for the operation.
createAlias?boolean | IResolvableIf set to true , specifies an alias for a directory and assigns the alias to the directory.
description?stringA description for the directory.
enableSso?boolean | IResolvableWhether to enable single sign-on for a directory.
password?stringThe password for the directory administrator.
shortName?stringThe NetBIOS name of the directory, such as CORP .

name

Type: string

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


size

Type: string

The size of the directory.

For valid values, see CreateDirectory in the AWS Directory Service API Reference .


vpcSettings

Type: IResolvable | VpcSettingsProperty

A DirectoryVpcSettings object that contains additional information for the operation.


createAlias?

Type: boolean | IResolvable (optional)

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.


description?

Type: string (optional)

A description for the directory.


enableSso?

Type: boolean | IResolvable (optional)

Whether to enable single sign-on for a directory.

If you don't specify a value, AWS CloudFormation disables single sign-on by default.


password?

Type: string (optional)

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 API call in the AWS Directory Service API Reference .


shortName?

Type: string (optional)

The NetBIOS name of the directory, such as CORP .