STEP

Upload content

This AWS S3 step allows you to upload content to an S3 bucket

Specification

aws

Required

object
A mapping of AWS account configuration.
aws.connection

Required

A Relay AWS connection to useConnection docs
!Connection {type: aws, name: my-aws-connection}
aws.region

Required

string
The AWS region to use (for example, us-west-2)
bucket

Required

string
The name of the target S3 bucket
key
Optional
string
Specify a key name for the object.
sourcePath
Optional
string
The relative path, within the Git repository given in the git parameters, to upload. One of sourcePath or sourceContent must be specified.
sourceContent
Optional
string
The data to upload as a string.
git
Optional
object
A map of git configuration. If you're using HTTPS, only name and repository are required.
git.ssh_key

Required

string
The SSH key to use when cloning the git repository. You can pass the key to Relay as a secret. See the example below.
git.known_hosts
Optional
string
SSH known hosts file. Use a Relay secret to pass the contents of the file into the workflow as a base64-encoded string. See the example below.
git.name

Required

string
A directory name for the git clone.
git.branch
Optional
string
The Git branch to clone.
git.repository

Required

string
The git repository URL.
filters[]
Optional
array
A YAML sequence (array) of path filters, applied in order.
filters[].type

Required

string
The type of the filter, one of include or exclude.
filters[].pattern

Required

string
The pattern for the filter. See the S3 CLI documentation for details on the syntax.
acl
Optional
string
The canned ACL to use for the uploaded objects. For a list of canned ACLs, see Access Control List (ACL) Overview
storageClass
Optional
string
The storage class to use for the uploaded objects. For informaton on storage classes, see Amazon S3 Storage Classes
contentType
Optional
string
The media type of the uploaded object. Automatically detected when using sourcePath if possible.
cacheControl
Optional
string
The value of the HTTP Cache-Control header to associate with the uploaded objects.
contentDisposition
Optional
string
The value of the HTTP Content-Disposition header to associate with the uploaded objects.
contentEncoding
Optional
string
The value of the HTTP Content-Encoding header to associate with the uploaded objects.
contentLanguage
Optional
string
The value of the HTTP Content-Language header to associate with the uploaded objects.
expires
Optional
string
The time at which the uploaded object is no longer cacheable, in ISO 8601 format.
metadata
Optional
object
A YAML mapping of arbitrary key-value data to store with the uploaded objects.

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.