Skip to main content
The install stack provisions the runner in your customer’s AWS account. AWS installs can use a CloudFormation stack, and this guide walks through launching the generated template. When an install uses a CloudFormation stack, the await install stack step in the dashboard surfaces a one-click launch link, the template URL, and ready-to-run AWS CLI commands.
CloudFormation is AWS-only. For AWS you can also use a Terraform stack; GCP and Azure use Terraform.

Prerequisites

  • AWS access — access to the target AWS account with permission to create CloudFormation stacks and the IAM resources the template defines. The stack is created with the CAPABILITY_NAMED_IAM capability.
  • AWS CLI (optional) — to launch from the command line, install and configure the AWS CLI with credentials for the target account.

Launch from the AWS console

1

Open the quick-launch link

On the await install stack step, click Quick launch in AWS console. This opens CloudFormation’s quick-create flow with the template URL and stack name prefilled. If you don’t see the link, open the AWS console in your target region and create a stack from the template URL shown on the step.
2

Create the stack

Review the stack, acknowledge that it creates named IAM resources, and create it. CloudFormation provisions the runner in your account.
3

Monitor progress

Use Open in AWS console on the step (or the CloudFormation console) to watch the stack’s events until it reaches CREATE_COMPLETE. Once it’s up, the install continues.

Launch with the AWS CLI

The dashboard generates the exact commands with your stack name, template URL, and region filled in. Copy them from the await install stack step — the general form is:
1

Create the stack

aws cloudformation create-stack \
  --stack-name <stack-name> \
  --template-url <template-url> \
  --capabilities CAPABILITY_NAMED_IAM \
  --region <region>
2

Update an existing stack

To apply a new template version to a stack you already created:
aws cloudformation update-stack \
  --stack-name <stack-name> \
  --template-url <template-url> \
  --capabilities CAPABILITY_NAMED_IAM \
  --region <region>
3

Verify

Open the CloudFormation console (the Open in AWS console button on the step links straight to the stack’s events) and wait for CREATE_COMPLETE / UPDATE_COMPLETE.