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

Class: Aws::DirectoryService::Types::CreateMicrosoftADRequest

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 CreateMicrosoftADRequest data as a hash:

{
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "Password", # required
  description: "Description",
  vpc_settings: { # required
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
  },
  edition: "Enterprise", # accepts Enterprise, Standard
}

Creates a Microsoft AD in the AWS cloud.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

Returns:

  • (String)


607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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

#editionString

AWS Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

Returns:

  • (String)


607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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

#nameString

The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

Returns:

  • (String)


607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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

#passwordString

The password for the default administrative user named Admin.

Returns:

  • (String)


607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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

#short_nameString

The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

Returns:

  • (String)


607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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

#vpc_settingsTypes::DirectoryVpcSettings

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.



607
608
609
610
611
612
613
614
615
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 607

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