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>

  The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

• #domain ⇒ String

  The name of the Windows domain that the SMB server belongs to.

• #location_arn ⇒ String

  The Amazon Resource Name (ARN) of the SMB location 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

  The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

• #subdirectory ⇒ String

  The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination.

• #user ⇒ String

  The user who can mount the share has the permissions to access files and folders in the SMB share.

Instance Attribute Details

#agent_arns ⇒ Array<String>

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Returns:

• (Array<String>)

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

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

#domain ⇒ String

The name of the Windows domain that the SMB server belongs to.

Returns:

• (String)

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

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

#location_arn ⇒ String

The Amazon Resource Name (ARN) of the SMB location to update.

Returns:

• (String)

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

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 5100

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

#password ⇒ String

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

• (String)

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

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

#subdirectory ⇒ String

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

• Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.

• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

Returns:

• (String)

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

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

#user ⇒ String

The user who can mount the share has the permissions to access files and folders in the SMB share.

Returns:

• (String)

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

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