Deploy CloudFormation stack

step

Runs a CloudFormation deploy to create or update a stack contained in a Git repository.

Specification

aws

Required

object
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)
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 git repository to clone
git.connection
Optional
A Relay SSH connection to useConnection docs
!Connection {type: ssh, name: my-ssh-connection}
git.knownHosts
Optional
string
SSH known hosts file
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.

Join our community

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.