You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectoryService::Types::CreateDirectoryRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDirectoryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "Password", # required
  description: "Description",
  size: "Small", # required, accepts Small, Large
  vpc_settings: {
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Contains the inputs for the CreateDirectory operation.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the directory.

Returns:

  • (String)

    A description for the directory.

#nameString

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

Returns:

  • (String)

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

#passwordString

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 ResetUserPassword 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.

Returns:

  • (String)

    The password for the directory administrator.

#short_nameString

The NetBIOS name of the directory, such as CORP.

Returns:

  • (String)

    The NetBIOS name of the directory, such as CORP.

#sizeString

The size of the directory.

Possible values:

  • Small
  • Large

Returns:

  • (String)

    The size of the directory.

#tagsArray<Types::Tag>

The tags to be assigned to the Simple AD directory.

Returns:

  • (Array<Types::Tag>)

    The tags to be assigned to the Simple AD directory.

#vpc_settingsTypes::DirectoryVpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.

Returns: