class Aws::DataSync::Types::UpdateLocationSmbRequest

@note When making an API call, you may pass UpdateLocationSmbRequest

data as a hash:

    {
      location_arn: "LocationArn", # required
      subdirectory: "SmbSubdirectory",
      user: "SmbUser",
      domain: "SmbDomain",
      password: "SmbPassword",
      agent_arns: ["AgentArn"],
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
      },
    }

@!attribute [rw] location_arn

The Amazon Resource Name (ARN) of the SMB location to update.
@return [String]

@!attribute [rw] subdirectory

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.

<note markdown="1"> `Subdirectory` must be specified with forward slashes. For example,
`/path/to/folder`.

 </note>

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.
@return [String]

@!attribute [rw] user

The user who can mount the share has the permissions to access files
and folders in the SMB share.
@return [String]

@!attribute [rw] domain

The name of the Windows domain that the SMB server belongs to.
@return [String]

@!attribute [rw] password

The password of the user who can mount the share has the permissions
to access files and folders in the SMB share.
@return [String]

@!attribute [rw] agent_arns

The Amazon Resource Names (ARNs) of agents to use for a Simple
Message Block (SMB) location.
@return [Array<String>]

@!attribute [rw] mount_options

Represents the mount options that are available for DataSync to
access an SMB location.
@return [Types::SmbMountOptions]

@see docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation

Constants

SENSITIVE