Skip to content

Create Directory

directoryservice_create_directory R Documentation

Creates a Simple AD directory

Description

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.

Before you call create_directory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the create_directory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Usage

directoryservice_create_directory(Name, ShortName, Password,
  Description, Size, VpcSettings, Tags)

Arguments

Name

[required] The fully qualified name for the directory, such as corp.example.com.
ShortName

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

[required] 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, you can use the reset_user_password API call.

The regex pattern for this string is made up of the following conditions:

  • Length (?=^.{8,64}$) – Must be between 8 and 64 characters

AND any 3 of the following password complexity rules required by Active Directory:

  • Numbers and upper case and lowercase (?=.\d)(?=.[A-Z])(?=.*[a-z])

  • Numbers and special characters and lower case (?=.\d)(?=.[^A-Za-z0-9\s])(?=.*[a-z])

  • Special characters and upper case and lower case (?=.[^A-Za-z0-9\s])(?=.[A-Z])(?=.*[a-z])

  • Numbers and upper case and special characters (?=.\d)(?=.[A-Z])(?=.*[^A-Za-z0-9\s])

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
Description

A description for the directory.
Size

[required] The size of the directory.
VpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.
Tags

The tags to be assigned to the Simple AD directory.

Value

A list with the following syntax:

list(
  DirectoryId = "string"
)

Request syntax

svc$create_directory(
  Name = "string",
  ShortName = "string",
  Password = "string",
  Description = "string",
  Size = "Small"|"Large",
  VpcSettings = list(
    VpcId = "string",
    SubnetIds = list(
      "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)