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

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::JoinDomainInput

Includes:

Aws::Structure

Defined in:

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"],
  timeout_in_seconds: 1,
  user_name: "DomainUserName", # required
  password: "DomainUserPassword", # required
}

JoinDomainInput

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #domain_controllers ⇒ Array<String>

  List of IPv4 addresses, NetBIOS names, or host names of your domain server.

• #domain_name ⇒ String

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

• #gateway_arn ⇒ String

  The Amazon Resource Name (ARN) of the gateway.

• #organizational_unit ⇒ String

  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.

• #password ⇒ String

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

• #timeout_in_seconds ⇒ Integer

  Specifies the time in seconds, in which the ‘JoinDomain` operation must complete.

• #user_name ⇒ String

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

Instance Attribute Details

#domain_controllers ⇒ Array<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>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#domain_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#gateway_arn ⇒ String

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#organizational_unit ⇒ String

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#password ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#timeout_in_seconds ⇒ Integer

Specifies the time in seconds, in which the ‘JoinDomain` operation must complete. The default is 20 seconds.

Returns:

• (Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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

#user_name ⇒ String

Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 4237

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