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.
| Setting | Description |
|---|
| Connector Id | The static, unique identifier for the connector. |
| Connector Type | Displays the connector name and a description of what it does. |
| Connector Description | An optional field to provide a free-form description of the connector and its role in the flow. |
| Service | Use the dropdown to choose which service to connect to. Select Other to specify the base URL to use when connecting to the service. |
| Bucket Name | The S3 bucket to poll or upload to. |
| Region | The Region where the specified Bucket Name is stored. |
Account Settings
Settings related to the account with permission to access the configured Bucket Name.
| Setting | Description |
|---|
| IAM Role | Whether to use the attached IAM role to access S3. Only use this setting when is hosted on an EC2 instance that has an IAM role attached. The IAM credentials replace the two Key options below. |
| Access Key | The Access Key account credential acquired from Amazon (or the S3-like service). |
| Secret Key | The Secret Key account credential acquired from Amazon (or the S3-like service). |
| Assume Role ARN | Use the two Key options above to call the Amazon STS service to obtain temporary credentials to access S3 with the provided role ARN. |
TLS Settings
Settings related to TLS negotiation with the S3 server.
| Setting | Description |
|---|
| TLS | Check this to enable TLS negotiation. |
| Server Public Certificate | The public key certificate used to verify the identity of a TLS/SSL server. This is only necessary if the server requires a specific certificate for validation. If the server does not provide a TLS server certificate, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or set it to Any Certificate to unconditionally trust the target server’s identity. |
Upload
Settings related to the path in the specified bucket where files are uploaded.
| Setting | Description |
|---|
| Prefix | The remote path on the server where files are uploaded. |
| Overwrite Action | Whether to overwrite, skip, or fail existing files. |
Download
Settings related to the path in the specified bucket where files are downloaded.
| Setting | Description |
|---|
| Prefix | The remote path on the server from where files are downloaded. |
| File Filter | A glob pattern filter to determine which files should be downloaded from the remote storage (for example, *.txt). You can use negative patterns to indicate files that should not be downloaded (for example, -*.tmp). Multiple patterns can be separated by commas, with later filters taking priority except when an exact match is found. |
| Delete | Check this to delete successfully downloaded files from the remote storage. |
Caching
Settings related to caching and comparing files between multiple downloads.
| Setting | Description |
|---|
| File Size Comparison | Check this to keep a record of downloaded file names and sizes. Previously downloaded files are skipped unless the file size is different than the last download. |
| Timestamp Comparison | Check this to keep a record of downloaded file names and last-modified timestamps. Previously downloaded files are skipped unless the timestamp is different than the last download. |
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.
| Setting | Description |
|---|
| Access Policy | The access policy set on objects after they are uploaded to the S3 server. |
| Encryption Password | If set, object data is encrypted on the client side before upload, and downloaded objects are automatically decrypted. |
| Recurse | Whether to download files in subfolders of the target remote path. |
| Local File Scheme | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros. |
| Server Side Encryption | Whether to use server-side AES256 encryption. |
| TLS Enabled Protocols | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. Some obsolete operating systems do not support TLS 1.2. |
| Virtual Hosting | Whether to use hosted-style or path-style requests when referencing the bucket endpoint. |
| Processing Delay | The amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting. |
Proxy Settings
Logging
Miscellaneous
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.
| Setting | Description |
|---|
| Send | Whether files arriving at the connector are automatically uploaded. |
| Retry Interval | The amount of time before a failed upload is retried. |
| Max Attempts | The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If this is set to 0, the connector retries the file indefinitely. |
| Receive | Whether the connector should automatically poll the remote download path for files to download. |
| Interval | The interval between automatic download attempts. |
| Minutes Past the Hour | The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc. |
| Time | The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly. |
| Day | The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly. |
| Minutes | The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute. |
| Cron Expression | A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced. |
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)
- 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
