Skip to main content

S3 Cloud Storage

Store and retrieve files from S3-compatible storage. Works with AWS S3, MinIO, Cloudflare R2, and Google Cloud Storage (S3-compatible mode).
Requires the @aws-sdk/client-s3 and @aws-sdk/s3-request-presigner peer dependencies.

Quick Start


Config

string
S3 bucket name. Falls back to S3_BUCKET env var.
string
default:"us-east-1"
AWS region. Falls back to AWS_REGION env var.
string
Custom endpoint URL for S3-compatible services (MinIO, R2, GCS).
boolean
default:"false"
Force path-style addressing. Enable for MinIO.
string
AWS Access Key ID. Falls back to AWS_ACCESS_KEY_ID env var.
string
AWS Secret Access Key. Falls back to AWS_SECRET_ACCESS_KEY env var.

Tools


Peer Dependencies


S3-Compatible Services


Environment Variables