?
Connect an S3 source
Points a corpus at an S3 bucket so its objects can be synced in as documents.
admin.dataSourceConnectors.connect({ slug, bucket, region, prefix?, endpoint?, accessKeyIdSecret, secretAccessKeySecret, deletions?, budgetDollarsPerSync? })
Attaches an S3 bucket to a corpus as its origin. The keys are read from app secrets by name, never passed inline, so the credentials stay out of the command and the logs. --deletions mirror, the default, removes a document when its source object is gone; keep leaves it. Once connected, sync pulls the bucket in.
Parameters
--source
string
RequiredCorpus slug. Created on first use, like add.
--bucket
string
RequiredS3 bucket name.
--region
aws-region
RequiredThe bucket's AWS region, e.g. us-east-1.
--prefix
string
Key prefix to follow; omit for the whole bucket.
--endpoint
url
S3-compatible endpoint; omit for AWS.
--access-key-secret
NAME
RequiredName of the app secret holding the access key id.
--secret-key-secret
NAME
RequiredName of the app secret holding the secret access key.
--deletions
mirror|keep
Whether a removed object removes its document. Default mirror.
--budget-per-sync
dollars
Ceiling a sync auto-approves under.
CLI
remy-admin datasources connect --source docs --bucket my-bucket --region us-east-1 \ --prefix reports/ --access-key-secret S3_KEY --secret-key-secret S3_SECRET