Amazon S3 with YAML

Tip

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

YAML parameters for Amazon 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 `AMAZON_S3`.
bucket_name `Required`	String	The name of the Amazon S3 Bucket.
integration `Required`	String	The ID of the integration.
input_type	String	Defines whether the files are deployed from the repository or from the build filesystem. Can be one of `SCM_REPOSITORY` or `BUILD_ARTIFACTS`.
local_path	String	The path in the repository.
acl	String	Access control lists (ACLs) enable you to manage access to buckets and objects. It defines which AWS accounts or groups are granted access and the type of access.
remote_path	String	The absolute or relative path on the remote server.
deployment_excludes	String[]	The paths and/or files that will be left out during the deployment.
deployment_includes	String[]	The exceptions from the ignore patterns set in `deployment_excludes`.
expires_date	ISO8601 UTC date	Specifies the expiration period for the objects (how long they stay in the cache).
cache_control	String	Specifies how long objects stay in the cache.
skip_content_type_setting	Boolean	When set to `true` all files will have their mime-types set to `application/octet-stream`.
reduced_redundancy	Boolean	Set to `true` if you want to use Reduced Redundancy Storage
deploy_tags	Tag[]	Defines tags for files categorization as a key value pairs list.
deletion_disabled	Boolean	If set to `true`, files are not deleted if changeset indcates that.
content_encoding	String	ContentEncoding that will be set for the deployed files e.g. "gzip".

YAML example for Amazon S3

yaml
actions:
- action: "Upload files to AWS S3/buddy"
  type: "AMAZON_S3"
  input_type: "SCM_REPOSITORY"
  local_path: "/assets"
  bucket_name: "buddy"
  acl: "PUBLIC_READ_WRITE"
  reduced_redundancy: true
  skip_content_type_setting: true
  expires_date: "2017-12-31T23:00:00.000Z"
  cache_control: "max-age=3600"
  integration: "my_integration"
  deploy_tags:
  - key: "revision"
    value: "$BUDDY_RUN_COMMIT"
  - key: "buddy_last_modification_type"
    value: "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE"
  deletion_disabled: true
  deployment_excludes:
  - "/tmp"
  - "*.log"
  deployment_includes:
  - "/tmp/assets"
  - "/tmp/styles"

Hint

Integration with AWS is one of the key features of Buddy. Check all the benefits of cloud-based programming at aws.amazon.com

Last modified on Mar 4, 2025

YAML Schema AWS App Runner Deploy

On this page

YAML parameters for Amazon S3 YAML example for Amazon S3