Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateLocationSmbCommandInputProtected

The input for CreateLocationSmbCommand.

Hierarchy

Properties

AgentArns: undefined | 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).

Domain?: string

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

For more information, see required permissions for SMB locations.

MountOptions?: SmbMountOptions

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

Password: undefined | 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.

ServerHostname: undefined | string

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

You can't specify an IP version 6 (IPv6) address.

Subdirectory: undefined | 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.

Tags?: 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.

User: undefined | 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.