Amazon S3

Configure S3 and S3-compatible storage

Configuration

data_pools:
  - id: s3-documents
    type: s3
    access_key_id: $AWS_ACCESS_KEY_ID
    secret_access_key: $AWS_SECRET_ACCESS_KEY
    endpoint: https://s3.amazonaws.com
    bucket_name: my-bucket
    provider: "AWS"

Configuration Options

FieldTypeDefaultRequiredDescription
idstring-Unique identifier for the data pool
typestring-Must be "s3"
access_key_idstring-AWS access key
secret_access_keystring-AWS secret key
endpointstring-S3 endpoint URL
bucket_namestring-S3 bucket name
providerstring"Other"Provider ("AWS", "MinIO", "DigitalOcean", "Other")
base_pathstring""Optional folder prefix

Setup

  1. Create IAM user: AWS IAM Console
  2. Attach S3 policy: Give read-only access to your bucket
  3. Generate access keys: Copy Access Key ID and Secret
  4. Add to environment: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

Amazon S3 Documentation