class Aws::DataSync::Types::CreateLocationSmbRequest

CreateLocationSmbRequest

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

data as a hash:

    {
      subdirectory: "SmbSubdirectory", # required
      server_hostname: "ServerHostname", # required
      user: "SmbUser", # required
      domain: "SmbDomain",
      password: "SmbPassword", # required
      agent_arns: ["AgentArn"], # required
      mount_options: {
        version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
      },
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    }

@!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 you specified, DataSync needs
to have permissions to mount the SMB share, as well as to access all
the data in that share. To ensure this, either 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, or use credentials of
a member of the Backup Operators group to mount the share. Doing
either enables the agent to access the data. For the agent to access
directories, you must additionally enable all execute access.
@return [String]

@!attribute [rw] server_hostname

The name of the SMB server. This value is the IP address or Domain
Name Service (DNS) name of the SMB server. An agent that is
installed on-premises uses this hostname to mount the SMB server in
a network.

<note markdown="1"> This name must either be DNS-compliant or must be an IP version 4
(IPv4) address.

 </note>
@return [String]

@!attribute [rw] user

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

For information about choosing a user name that ensures sufficient
permissions to files, folders, and metadata, see
[user](create-smb-location.html#SMBuser).
@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

The mount options used by DataSync to access the SMB server.
@return [Types::SmbMountOptions]

@!attribute [rw] tags

The key-value pair that represents the tag that you want to add to
the location. The value can be an empty string. We recommend using
tags to name your resources.
@return [Array<Types::TagListEntry>]

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

Constants

SENSITIVE