Class: Aws::DataSync::Types::UpdateLocationSmbRequest

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::UpdateLocationSmbRequest

Defined in:

gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

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 Windows domain name that your SMB file server belongs to.

• #location_arn ⇒ String

  Specifies the ARN of the SMB location that you want to update.

• #mount_options ⇒ Types::SmbMountOptions

  Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an 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.

• #subdirectory ⇒ String

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

• #user ⇒ String

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

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 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 6071

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

#domain ⇒ String

Specifies the Windows domain name that your SMB file server belongs to.

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

For more information, see required permissions for SMB locations.

Returns:

• (String)

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

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

#location_arn ⇒ String

Specifies the ARN of the SMB location that you want to update.

Returns:

• (String)

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

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

#mount_options ⇒ Types::SmbMountOptions

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

Returns:

• (Types::SmbMountOptions)

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

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  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.

Returns:

• (String)

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

class UpdateLocationSmbRequest < Struct.new(
  :location_arn,
  :subdirectory,
  :user,
  :domain,
  :password,
  :agent_arns,
  :mount_options)
  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 specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

Returns:

• (String)

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

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

#user ⇒ String

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

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

Returns:

• (String)

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

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