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

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
  },
}

Contains the inputs for the CreateDirectory operation.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A textual description for the directory.

Returns:

  • (String)


532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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

#nameString

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

Returns:

  • (String)


532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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

#passwordString

The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.

Returns:

  • (String)


532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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

#short_nameString

The short name of the directory, such as CORP.

Returns:

  • (String)


532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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

#sizeString

The size of the directory.

Returns:

  • (String)


532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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

#vpc_settingsTypes::DirectoryVpcSettings

A DirectoryVpcSettings object that contains additional information for the operation.



532
533
534
535
536
537
538
539
540
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 532

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