Skip to main content
Version: v0.4.0

remote::s3

Description​

AWS S3-based file storage provider for scalable cloud file management with metadata persistence.

Configuration​

FieldTypeRequiredDefaultDescription
bucket_namestrNoS3 bucket name to store files
regionstrNous-east-1AWS region where the bucket is located
aws_access_key_idstr | NoneNoAWS access key ID (optional if using IAM roles)
aws_secret_access_keystr | NoneNoAWS secret access key (optional if using IAM roles)
endpoint_urlstr | NoneNoCustom S3 endpoint URL (for MinIO, LocalStack, etc.)
auto_create_bucketboolNoFalseAutomatically create the S3 bucket if it doesn't exist
metadata_storeSqlStoreReferenceNoSQL store configuration for file metadata

Sample Configuration​

bucket_name: ${env.S3_BUCKET_NAME}
region: ${env.AWS_REGION:=us-east-1}
aws_access_key_id: ${env.AWS_ACCESS_KEY_ID:=}
aws_secret_access_key: ${env.AWS_SECRET_ACCESS_KEY:=}
endpoint_url: ${env.S3_ENDPOINT_URL:=}
auto_create_bucket: ${env.S3_AUTO_CREATE_BUCKET:=false}
metadata_store:
table_name: s3_files_metadata
backend: sql_default