Documentation CLI 0.1.1 · development llms.txt

coldctl destination add s3

Configure an S3 archive destination.

ImplementedLocal destination configuration

Syntax

USAGE

coldctl destination add s3 [OPTIONS] --name <NAME> --bucket <BUCKET> --region <REGION>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--name <NAME>`	Destination name.
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--bucket <BUCKET>`	Existing S3 bucket.
`--region <REGION>`	AWS region.
`--prefix <PREFIX>`	[default: coldctl]
`--endpoint <ENDPOINT>`	Optional explicit S3-compatible endpoint for environment credentials.
`--staging-path <STAGING_PATH>`	Durable local staging directory; only pending batches remain here
`--access-key-env <ACCESS_KEY_ENV>`	[default: AWS_ACCESS_KEY_ID]
`--secret-key-env <SECRET_KEY_ENV>`	[default: AWS_SECRET_ACCESS_KEY]
`--session-token-env <SESSION_TOKEN_ENV>`	Environment variable containing the optional static AWS session token.
`--allow-http`	Permit HTTP only for an explicitly configured loopback emulator
`--role-auth`	Use automatically refreshed cloud identity credentials (standard endpoints only)
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl destination add s3 --name archives --bucket customer-archive --region us-east-1 --role-auth

Operational notes

Use --role-auth on EC2 for refreshed IAM role credentials or with AWS web identity. Custom endpoints and static session-token references are rejected in role mode. Otherwise credentials use the named environment variables. Provision storage separately and run destination test before archival.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Configure customer-owned S3 or a loopback S3 emulator

Usage: coldctl destination add s3 [OPTIONS] --name <NAME> --bucket <BUCKET> --region <REGION>

Options:
      --data-dir <PATH>
          Override the OS application data directory
      --name <NAME>
          
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --bucket <BUCKET>
          
      --region <REGION>
          
      --prefix <PREFIX>
          [default: coldctl]
      --endpoint <ENDPOINT>
          
      --staging-path <STAGING_PATH>
          Durable local staging directory; only pending batches remain here
      --access-key-env <ACCESS_KEY_ENV>
          [default: AWS_ACCESS_KEY_ID]
      --secret-key-env <SECRET_KEY_ENV>
          [default: AWS_SECRET_ACCESS_KEY]
      --session-token-env <SESSION_TOKEN_ENV>
          
      --allow-http
          Permit HTTP only for an explicitly configured loopback emulator
      --role-auth
          Use automatically refreshed cloud identity credentials (standard endpoints only)
  -h, --help
          Print help