interface CfnSimpleADMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.DirectoryService.Mixins.CfnSimpleADMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdirectoryservice/mixins#CfnSimpleADMixinProps
Java	software.amazon.awscdk.mixins.preview.services.directoryservice.mixins.CfnSimpleADMixinProps
Python	aws_cdk.mixins_preview.aws_directoryservice.mixins.CfnSimpleADMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_directoryservice » mixins » CfnSimpleADMixinProps

Properties for CfnSimpleADPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as directoryservice_mixins } from '@aws-cdk/mixins-preview/aws-directoryservice';
const cfnSimpleADMixinProps: directoryservice_mixins.CfnSimpleADMixinProps = {
  createAlias: false,
  description: 'description',
  enableSso: false,
  name: 'name',
  password: 'password',
  shortName: 'shortName',
  size: 'size',
  vpcSettings: {
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },
};

Properties

Name	Type	Description
createAlias?	boolean | IResolvable	If set to true , specifies an alias for a directory and assigns the alias to the directory.
description?	string	A description for the directory.
enableSso?	boolean | IResolvable	Whether to enable single sign-on for a directory.
name?	string	The fully qualified name for the directory, such as corp.example.com .
password?	string	The password for the directory administrator.
shortName?	string	The NetBIOS name of the directory, such as CORP .
size?	string	The size of the directory.
vpcSettings?	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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias

---

description?

Type: string (optional)

A description for the directory.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description

---

enableSso?

Type: boolean | IResolvable (optional)

Whether to enable single sign-on for a directory.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso

---

name?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name

---

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 Directory Service API Reference .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password

---

shortName?

Type: string (optional)

The NetBIOS name of the directory, such as CORP .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname

---

size?

Type: string (optional)

The size of the directory.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size

---

vpcSettings?

Type: IResolvable | VpcSettingsProperty (optional)

A DirectoryVpcSettings object that contains additional information for the operation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings