SFTP Put Object

SFTP Put Object

SFTP Put Object

Transfer a file from Amazon S3 onto a remote host through SFTP.


Property Setting Description
Name Text The descriptive name for the component.
Set Home Directory as Root Choice The OuputData URL may be a path relative to the server root, or the home directory of the connecting user. "No" means the paths are relative to the server root, "Yes" means paths are relative to the home directory.
Output Data URL Text The URL, including full path and file name, that points to the file to download onto the remote host. The format of the URL varies considerably, however a default 'template' is offered once you have chosen a connection protocol.
Note:Special characters used in this field (e.g. in usernames and passwords) must be URL-safe. See documentation on URL Safe Characters for more information. This can be avoided by using the Username and Password properties.
Username Text This is your URL connection username. It is optional and will only be used if the data source requests it.
Password Text This is your URL connection password. It is optional and will only be used if the data source requests it.Users have the option to store their password inside the component but we highly recommend using the Password Manager option.
SFTP Key Text This is your SFTP Private Key. It is optional, and will only be used if the data source requests it.
This must be the complete private key, in OpenSSH PEM format (e.g. beginning with "-----BEGIN XXX PRIVATE KEY-----").
S3 Path S3 Tree The S3 path to read the file from. A public S3 URL can be entered in the text box, although you must have read access. This component shows individual files as well as folders - a file on S3 must be specified, not a folder. If a given folder contains more than 1,000 objects, only the first 1,000 are listed, however you may type the full path and object name into the URL even if the object is not visible in the tree.

The template offered for the Output Data URL contains square brackets - these indicate an optional part of the URL, and should not be included. For example, the username/password can be specified in the URL, although it would generally be better to enter them into the Username and Password parameters instead.

Variable Exports

This component makes the following values available to export into variables:

Source Description
Bytes written The number of bytes read from the source and written to S3.


This example takes the data in a Redshift table, exports that data to S3 (using S3 Unload), and then copies the resulting file to a SFTP location.

The unload is configured to use a single file (by setting the Parallel option to No). Redshift will still add a suffix of 000 to the export files.

Moving the file to an SFTP location is similar to the S3 Put Object component.

Notice that the S3 Path points to airports_export.csv000 but the target file in the Output Data URL can be anything.