• Docs
• Plugins
• Destinations
• S3
• Overview

S3 Destination Plugin

This destination plugin lets you sync data from a CloudQuery source to remote S3 storage in various formats such as CSV, JSON.

This is useful in various use-cases, especially in data lakes where you can query the data direct from Athena or load it to various data warehouses such as BigQuery, RedShift, Snowflake and others.

Authentication

Authenitcation is similar to AWS CLI. See also aws source plugin for more information.

Example

This example configures a CSV destination, to create CSV files in s3://bucket_name/path/to/files. Note that the S3 plugin only supports append write-mode.

The (top level) spec section is described in the Destination Spec Reference.

kind: destination
spec:
  name: "s3"
  path: "cloudquery/s3"
  version: "v1.0.1"
  write_mode: "append" # s3 only supports 'append' mode

  spec:
    bucket: "bucket_name"
    path: "path/to/files"
    format: "csv"

S3 Spec

This is the (nested) spec used by the CSV destination Plugin.

• bucket (string) (required)

  Bucket where to sync the files.

• path (string) (required)

  Path to where the files will be uploaded in the above bucket.

• format (string) (required)

  Format of the output file. json and csv are supported.