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

Class: Aws::StorageGateway::Types::JoinDomainInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass JoinDomainInput data as a hash:

{
  gateway_arn: "GatewayARN", # required
  domain_name: "DomainName", # required
  organizational_unit: "OrganizationalUnit",
  domain_controllers: ["Host"],
  user_name: "DomainUserName", # required
  password: "DomainUserPassword", # required
}

JoinDomainInput

Instance Attribute Summary collapse

Instance Attribute Details

#domain_controllersArray<String>

List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

Returns:

  • (Array<String>)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end

#domain_nameString

The name of the domain that you want the gateway to join.

Returns:

  • (String)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end

#gateway_arnString

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Returns:

  • (String)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end

#organizational_unitString

The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

Returns:

  • (String)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end

#passwordString

Sets the password of the user who has permission to add the gateway to the Active Directory domain.

Returns:

  • (String)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end

#user_nameString

Sets the user name of user who has permission to add the gateway to the Active Directory domain.

Returns:

  • (String)


3464
3465
3466
3467
3468
3469
3470
3471
3472
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3464

class JoinDomainInput < Struct.new(
  :gateway_arn,
  :domain_name,
  :organizational_unit,
  :domain_controllers,
  :user_name,
  :password)
  include Aws::Structure
end