Class: Aws::DataSync::Types::CreateLocationSmbRequest

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::CreateLocationSmbRequest

Includes:

Structure

Defined in:

lib/aws-sdk-datasync/types.rb

Overview

CreateLocationSmbRequest

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #agent_arns ⇒ Array<String>

  Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.

• #domain ⇒ String

  Specifies the name of the Active Directory domain that your SMB file server belongs to.

• #mount_options ⇒ Types::SmbMountOptions

  Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

• #password ⇒ String

  Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

• #server_hostname ⇒ String

  Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

• #subdirectory ⇒ String

  Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

• #tags ⇒ Array<Types::TagListEntry>

  Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

• #user ⇒ String

  Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Instance Attribute Details

#agent_arns ⇒ Array<String>

Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

Returns:

• (Array<String>)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#domain ⇒ String

Specifies the name of the Active Directory domain that your SMB file server belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#mount_options ⇒ Types::SmbMountOptions

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Returns:

• (Types::SmbMountOptions)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ String

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

For more information, see [required permissions] for SMB locations.

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_hostname ⇒ String

Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

<note markdown=“1”> You can’t specify an IP version 6 (IPv6) address.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#subdirectory ⇒ String

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, ‘/path/to/subdirectory`). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see

required permissions][1

for SMB locations.

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tags ⇒ Array<Types::TagListEntry>

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:

• (Array<Types::TagListEntry>)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user ⇒ String

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

For information about choosing a user with the right level of access for your transfer, see [required permissions] for SMB locations.

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1232

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end