Skip to main content
The S3 connector integrates with Amazon’s S3 (Simple Storage Service) and other S3-like services (such as Google Storage and Wasabi).

Key Capabilities

  • Amazon S3 and S3-compatible service integration (Google Storage, Wasabi) with IAM role and access key authentication
  • Bucket-based file organization with bidirectional transfers and prefix-based virtual folders
  • Client-side and server-side encryption options with configurable access policies
  • Optional caching to ensure only new or updated files are downloaded

Overview

Each S3 connector can automatically upload to and download from a single S3 bucket. Before you begin, you need an Amazon account with the appropriate credentials (or account credentials for the S3-like service you are using). Specify the upload and download paths in the bucket. The connector supports download filters by file name.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Host Configuration

Settings related to the remote connection target.

Account Settings

Settings related to the account with permission to access the configured Bucket Name.

TLS Settings

Settings related to TLS negotiation with the S3 server.

Upload

Settings related to the path in the specified bucket where files are uploaded.

Download

Settings related to the path in the specified bucket where files are downloaded.

Caching

Settings related to caching and comparing files between multiple downloads.
When you enable caching, the file names are case-insensitive. For example, the connector cannot distinguish between TEST.TXT and test.txt.

Advanced Tab

Advanced Settings

Settings not included in the previous categories.

Proxy Settings

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

The requirements for establishing an S3 connection are simple:
  • Amazon account credentials (or other S3-like account credentials)
    • Access Key
    • Secret Key
  • A bucket that can be accessed by the above account
For Amazon S3, use this link to obtain Access Key and Secret Key information from Amazon. Optionally, you can secure the connection with S3 servers with TLS by enabling the Use TLS option in the TLS Settings section.

Uploading

Upload to Remote Folders

The Prefix setting in the Upload section of the Settings page specifies the bucket path to upload files to. This allows for the logical separation of files into virtual folders in the same bucket.
S3 servers do not maintain a real folder structure, and uses application logic to present a pseudo folder structure. Slashes in the Prefix (/, \\) are interpreted as representing a folder hierarchy. This allows for uploading to or downloading from ‘subfolders’ in the bucket based on the slashes in the path.

Upload Automation

The S3 connector supports automatic upload via the Automation tab. When Upload automation is enabled, files that reach the Transactions tab for the connector are automatically uploaded to the specified Bucket Name at the specified Prefix. If a file fails to upload, the application attempts to send it again after the Retry Interval has elapsed. This process continues until the Max Attempts has been reached, after which the connector raises an error.

Downloading

Download from Remote Folders

The Prefix setting in the Download section of the Settings page specifies the bucket path to download files from. This allows for the logical separation of files into virtual folders in the same bucket. The File Filter setting provides a way to only download specific filenames in the specified path.
S3 servers do not maintain a real folder structure, and uses application logic to present a pseudo folder structure. Slashes in the Prefix (/, \\) are interpreted as representing a folder hierarchy. This allows for uploading to or downloading from ‘subfolders’ in the bucket based on the slashes in the path.

Download Automation

The S3 connector supports automatic download via the Automation tab. When Download automation is enabled, the connector automatically polls the remote bucket based on the specified Download Interval.

Macros

Examples