S3

s3 outbound uploads files to S3-compatible storage.

S3-compatible services such as MinIO are supported through the endpoint field.

Structure

{
  "type": "s3",
  "tag": "s3-out",
  "bucket": "my-bucket",
  "prefix": "backups/",
  "endpoint": "",
  "region": "us-east-1",
  "access_key_id": "",
  "secret_access_key": "",
  "session_token": "",
  "path_style": false,
  "list_object_version": "v2"
}

Fields

bucket

Required

The S3 bucket name.

prefix

Object key prefix.

Objects are placed at the root of the bucket if empty.

endpoint

Custom endpoint URL for S3-compatible storage.

AWS S3 endpoint from the region is used if empty.

region

AWS region.

us-east-1 is used by default.

access_key_id

AWS access key ID.

Uses the default credential chain if empty.

secret_access_key

AWS secret access key.

Uses the default credential chain if empty.

session_token

AWS session token for temporary STS credentials.

Omitted if empty.

path_style

Use path-style addressing of the form endpoint/bucket/key instead of virtual-hosted addressing of the form bucket.endpoint/key. Automatically enabled when a custom endpoint is set, since S3-compatible services such as MinIO require it.

list_object_version

Which ListObjects API to use, v1 or v2. v2 is used by default; set v1 for older S3-compatible services that do not support it.