Skip to main content
Version: 3.2

AWS S3 Bucket Listener

The AWS S3 Bucket Listener monitors S3 buckets for files and will execute a pre-defined Job Configuration (config-id) when triggered.

Notes

Add Bucket Permissions

application.properties

<ProgramDataDirectory>/Actian/FileFolderListener/conf/application.properties

Example

# AWS S3 Connection Info
aws.s3.accesskey=AKIAIOSFODNN7EXAMPLE
aws.s3.secretkey=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Listener Configuration

listeners.yml

<ProgramDataDirectory>/Actian/FileFolderListener/conf/listeners.yml

Example

IMPORTANT

Indentation is critical for YAML syntax!

listeners:   
- id: aws-bucket-listener-accounts
config-id: 90378
listener-type: aws
active: true
source-bucket-name: listener-bucket-us-east-1-accounts
source-bucket-region: us-east-1
source-file-prefix: Accounts
filename-override: Accounts.txt
- id: aws-bucket-listener-contacts
config-id: 90379
listener-type: aws
active: true
source-bucket-name: listener-bucket-us-east-1-contacts
source-bucket-region: us-east-1
source-file-prefix: Contacts
filename-override: Contacts.txt

Properties

Property
DescriptionDefault
idA unique identifier for the listener.
listener-typeAvailable listener types: local, aws, gcp, azure.
config-idThe Job Configuration id to run in Integration Manager.
activeWhether or not this listener is active.true
source-bucket-nameThe S3 bucket name to monitor for new files.
source-bucket-regionRegion of the S3 bucket.
Note: AWS S3 region codes are slightly different from GCP.
include-patternIGNORED. NOT SUPPORTED FOR THIS LISTENER.
source-file-prefixIncludes files if the file name matches the prefix pattern (that is, the file name starts with the characters) you specify. For example, Accounts (equivalent to regex: ^Accounts.*) matches Accounts.txt, Accounts.csv, Accounts_1.txt, etc.
filename-overrideThis value will override the filename passed to Integration Manager, regardless of the original source file name. The original source file name will always be used for backup and error files.