Download S3 with YAML

Tip

Learn more about: - S3 action features - S3 integrations - S3 alternatives

YAML parameters for Download S3

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The ID of the action.
type `Required`	String	The type of the action. Should be set to `DOWNLOAD_S3`.
bucket_name `Required`	String	The name of the Amazon S3 Bucket.
source_path `Required`	String	The path from which the file will be downloaded.
destination_path `Required`	String	The path in which the file will be saved.
integration `Required`	String	The ID of the integration.
overwrite	Boolean	Replace files if they already exist.
recursive	Boolean	If set to `true`, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.
download_excludes	String[]	The paths and/or files that will be left out during the download.
download_includes	String[]	The exceptions from the ignore patterns set in `download_excludes`.

YAML example for Download S3

yaml
actions:
- action: "Download files from AWS S3/bucketname"
  type: "DOWNLOAD_S3"
  bucket_name: "bucketname"
  source_path: "source"
  destination_path: "destination"
  recursive: true
  overwrite: true
  integration: "my_integration"
  download_excludes:
  - "/tmp"
  - "*.log"
  download_includes:
  - "/tmp/assets"
  - "/tmp/styles"

Last modified on Mar 4, 2025

Download GCS Email notification

On this page

YAML parameters for Download S3 YAML example for Download S3