variable

Variables, are module-level objects that essentially act as parameters for the module. When running Flowpipe, you can pass values on the command line, from a .fpvars file, or from environment variables, and you will be prompted for any variables that have no values.

You can reference variable values as var.<NAME>

Example Usage

Argument Reference

Argument	Type	Optional?	Description
default	Any	Optional	A default value. If no value is passed, the user is not prompted and the default is used.
description	String	Optional	A description of the variable. This text is included when the user is prompted for a variable's value.
enum	Set	Optional	A set of allowed values for the variable; no other values are allowed.
tags	Map	Optional	A map of key:value metadata for the benchmark, used to categorize, search, and filter. The structure is up to the mod author and varies by benchmark and provider.
type	Type	Optional	The variable type. This may be a primitive type string, number, bool, connection, connection.{type}, notifier, or a collection type list(), map(), or any (default any).

Variable Types

Variables may be simple types:

string
number
bool
connection
a typed connection, eg connection.aws, connection.github , etc.
notifier

Variables may also be collection types:

list(<TYPE>)
set(<TYPE>)
map(<TYPE>)
object({<ATTR NAME> = <TYPE>, ... })
tuple([<TYPE>, ...])

The keyword any may be used to indicate that any type is acceptable

Enum

Flowpipe supports an enum argument to provide a set of allowed values; no other values are allowed.