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

Class: Aws::DirectoryService::Types::ConnectDirectoryRequest

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

Overview

Note:

When passing ConnectDirectoryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "ConnectPassword", # required
  description: "Description",
  size: "Small", # required, accepts Small, Large
  connect_settings: { # required
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
    customer_dns_ips: ["IpAddr"], # required
    customer_user_name: "UserName", # required
  },
}

Contains the inputs for the ConnectDirectory operation.

Instance Attribute Summary collapse

Instance Attribute Details

#connect_settingsTypes::DirectoryConnectSettings

A DirectoryConnectSettings object that contains additional information for the operation.

Returns:

#descriptionString

A textual description for the directory.

Returns:

  • (String)

    A textual description for the directory.

#nameString

The fully-qualified name of the on-premises directory, such as corp.example.com.

Returns:

  • (String)

    The fully-qualified name of the on-premises directory, such as corp.example.com.

#passwordString

The password for the on-premises user account.

Returns:

  • (String)

    The password for the on-premises user account.

#short_nameString

The NetBIOS name of the on-premises directory, such as CORP.

Returns:

  • (String)

    The NetBIOS name of the on-premises directory, such as CORP.

#sizeString

The size of the directory.

Possible values:

  • Small
  • Large

Returns:

  • (String)

    The size of the directory.