s3

Sends message parts as objects to an Amazon S3 bucket. Each object is uploaded with the path specified with the path field.

# Common config fields, showing default values
output:
s3:
bucket: ""
path: ${!count:files}-${!timestamp_unix_nano}.txt
content_type: application/octet-stream
max_in_flight: 1
region: eu-west-1

In order to have a different path for each object you should use function interpolations described here, which are calculated per message of a batch.

Credentials

By default Benthos will use a shared credentials file when connecting to AWS services. It's also possible to set them explicitly at the component level, allowing you to transfer data across accounts. You can find out more in this document.

Performance

This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages with the field max_in_flight.

Fields

bucket

The bucket to upload messages to.

Type: string
Default: ""

path

The path of each message to upload. This field supports interpolation functions.

Type: string
Default: "${!count:files}-${!timestamp_unix_nano}.txt"

# Examples
path: ${!count:files}-${!timestamp_unix_nano}.txt
path: ${!metadata:kafka_key}.json
path: ${!json_field:doc.namespace}/${!json_field:doc.id}.json

content_type

The content type to set for each object. This field supports interpolation functions.

Type: string
Default: "application/octet-stream"

content_encoding

An optional content encoding to set for each object. This field supports interpolation functions.

Type: string
Default: ""

storage_class

The storage class to set for each object. This field supports interpolation functions.

Type: string
Default: "STANDARD"
Options: STANDARD, REDUCED_REDUNDANCY, GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE.

kms_key_id

An optional server side encryption key.

Type: string
Default: ""

force_path_style_urls

Forces the client API to use path style URLs, which helps when connecting to custom endpoints.

Type: bool
Default: false

max_in_flight

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: number
Default: 1

timeout

The maximum period to wait on an upload before abandoning it and reattempting.

Type: string
Default: "5s"

region

The AWS region to target.

Type: string
Default: "eu-west-1"

endpoint

Allows you to specify a custom endpoint for the AWS API.

Type: string
Default: ""

credentials

Optional manual configuration of AWS credentials to use. More information can be found in this document.

Type: object
Default: {"id":"","profile":"","role":"","role_external_id":"","secret":"","token":""}

credentials.profile

A profile from ~/.aws/credentials to use.

Type: string
Default: ""

credentials.id

The ID of credentials to use.

Type: string
Default: ""

credentials.secret

The secret for the credentials being used.

Type: string
Default: ""

credentials.token

The token for the credentials being used, required when using short term credentials.

Type: string
Default: ""

credentials.role

A role ARN to assume.

Type: string
Default: ""

credentials.role_external_id

An external ID to provide when assuming a role.

Type: string
Default: ""