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

Inherits:

Struct

• Object
• Struct
• Aws::DirectoryService::Types::CreateDirectoryRequest

Defined in:

gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Contains the inputs for the CreateDirectory operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #description ⇒ String

  A description for the directory.

• #name ⇒ String

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

• #password ⇒ String

  The password for the directory administrator.

• #short_name ⇒ String

  The NetBIOS name of the directory, such as CORP.

• #size ⇒ String

  The size of the directory.

• #tags ⇒ Array<Types::Tag>

  The tags to be assigned to the Simple AD directory.

• #vpc_settings ⇒ Types::DirectoryVpcSettings

  A DirectoryVpcSettings object that contains additional information for the operation.

Instance Attribute Details

#description ⇒ String

A description for the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#password ⇒ String

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)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#short_name ⇒ String

The NetBIOS name of the directory, such as CORP.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#size ⇒ String

The size of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the Simple AD directory.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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

#vpc_settings ⇒ Types::DirectoryVpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.

Returns:

• (Types::DirectoryVpcSettings)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 807

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