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

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

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 ConnectDirectoryRequest data as a 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.



303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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

#descriptionString

A textual description for the directory.

Returns:

  • (String)


303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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

#nameString

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

Returns:

  • (String)


303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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

#passwordString

The password for the on-premises user account.

Returns:

  • (String)


303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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

#short_nameString

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

Returns:

  • (String)


303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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

#sizeString

The size of the directory.

Returns:

  • (String)


303
304
305
306
307
308
309
310
311
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 303

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