Plan a Terraform configuration

step

Outputs the plan of the given Terraform module.

Specification

os
Optional
object
Additional packages and commands to run prior to terraform execution
os.packages[]
Optional
array
list of apk packages to install at container execution time
os.commands[]
Optional
array
List of shell commands to run after packages are installed but before Terrafrom executes
workspace
Optional
string
The name of the Terraform workspace to run
google
Optional
object
A mapping of Google account configuration.
google.connection

Required

A Relay GCP connection to useConnection docs
!Connection {type: gcp, name: my-gcp-connection}
aws
Optional
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)
directory
Optional
string
Subdirectory of the git repository containing the Terraform config root
varFiles[]
Optional
array
A list of variable files to include relative to the module directory
vars
Optional
object
A map of variables to set, overriding any defaults or variables from files
backendConfig
Optional
object
A map of backend configuration variables to be passed to terraform as -backend-config=key=value
git
Optional
object
A git repository containing the terraform code to run
git.connection
Optional
A Relay SSH connection to useConnection docs
!Connection {type: ssh, name: my-ssh-connection}
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.

Outputs

plan

Required

string
Terraform plan data to be used to apply this specific plan
changed
Optional
boolean
Boolean set to true if any resources will be changed by running the plan

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.