STEP

Deploy CloudFormation stack

This step runs a CloudFormation deploy to create or update a stack contained in a Git repository.

Specification

connection
Optional
object
A Relay AWS connection to use
connection.accessKeyID

Required

string
The acccessKeyID for the account
connection.secretAccessKey

Required

string
The secret key for the account
connection.region

Required

string
The default AWS region to use
stackName

Required

string
The name of the stack to create or update
template
Optional
string
The body of the CloudFormation template as a string in YAML or JSON. One of template or templateFile must be specified.
templateFile
Optional
string
The relative path, within the Git repository given in the git parameters, to the template file to deploy. One of template or templateFile must be specified.
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 into Relay as a secret.
git.known_hosts

Required

string
SSH known hosts file. Pass the contents of the file into Relay as a secret.
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
parameters
Optional
object
A key-value mapping of CloudFormation parameters to pass to the template
s3
Optional
object
An S3 bucket mapping for your s3 bucket and template
s3.bucket

Required

string
An S3 bucket to upload the template to. Required for templates larger than 51,200 bytes.
s3.prefix
Optional
string
A folder name to prefix the artifacts' file names with when it uploads them to the S3 bucket
capabilities
Optional
array
A list of capabilities to use for the deployment, such as CAPABILITY_NAMED_IAM
tags
Optional
object
A key-value mapping of tags to add to the deployment.

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.