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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Note:

When making an API call, you may pass CreateDirectoryRequest data as a 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.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description for the directory.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#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)


953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#short_nameString

The NetBIOS name of the directory, such as CORP.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#sizeString

The size of the directory.

Returns:

  • (String)


953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be assigned to the Simple AD directory.

Returns:



953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#vpc_settingsTypes::DirectoryVpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.



953
954
955
956
957
958
959
960
961
962
963
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 953

class CreateDirectoryRequest < Struct.new(
  :name,
  :short_name,
  :password,
  :description,
  :size,
  :vpc_settings,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end