Skip to main content
Configuration for AWS S3 storage operations. Defines the parameters needed to connect to and interact with AWS S3 storage services. Supports both standard AWS S3 and S3-compatible storage services through custom endpoints.

Properties

string
Name of the S3 bucket to store files in. Must be a valid S3 bucket name following AWS naming conventions.
string
AWS region where the S3 bucket is located. Examples: “us-east-1”, “eu-west-1”, “ap-southeast-1”
string
AWS access key ID for authentication. If undefined, will attempt to use default AWS credentials or environment variables.
string
AWS secret access key for authentication. If undefined, will attempt to use default AWS credentials or environment variables.
string
Custom endpoint URL for S3-compatible storage services. Use this for services like MinIO, DigitalOcean Spaces, or other S3-compatible APIs. For standard AWS S3, leave this undefined.

Examples