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

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

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

Overview

Note:

When passing CreateMicrosoftADRequest as input to an Aws::Client method, you can use a vanilla 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
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Creates an AWS Managed Microsoft AD directory.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)

    A description for the directory.

#editionString

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

Possible values:

  • Enterprise
  • Standard

Returns:

  • (String)

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

#nameString

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

Returns:

  • (String)

    The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com.

#passwordString

The password for the default administrative user named Admin.

If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

Returns:

  • (String)

    The password for the default administrative user named Admin.

#short_nameString

The NetBIOS name 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)

    The NetBIOS name for your domain, such as CORP.

#tagsArray<Types::Tag>

The tags to be assigned to the AWS Managed Microsoft AD directory.

Returns:

  • (Array<Types::Tag>)

    The tags to be assigned to the AWS Managed Microsoft AD directory.

#vpc_settingsTypes::DirectoryVpcSettings

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

Returns: