Legend
Inputs
User-configurable inputs that can vary per run — environment name, image tag, feature flags, etcPipelineInputDefinition
Union of all pipeline input definitions, discriminated bytype.Discriminated union. The type field selects which schema applies.PipelineBooleanInputDefinition
Boolean pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
booleanboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
boolean
Default value used when no value is provided at runtime
PipelineNumberInputDefinition
Number pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
numberboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
integer
Default value used when no value is provided at runtime(format:int32)
Module.NumberValueItem[]
Dropdown options restricting allowed valuesSee: Module.NumberValueItem
integer
Minimum allowed value (inclusive)(format:int32)
integer
Maximum allowed value (inclusive)(format:int32)
PipelineObjectInputDefinition
Object pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
objectboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
any
Default value used when no value is provided at runtime
PipelineStringArrayInputDefinition
String array pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
string_arrayboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
string[]
Default value used when no value is provided at runtime
Module.ValidationPattern[]
Regex patterns each array element must matchSee: Module.ValidationPattern
PipelineStringInputDefinition
String pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
stringboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
string
Default value used when no value is provided at runtime
Module.StringValueItem[]
Dropdown options restricting allowed valuesSee: Module.StringValueItem
Module.ValidationPattern[]
Regex patterns the value must matchSee: Module.ValidationPattern
PipelineTextInputDefinition
Text pipeline input definitionstring
required
Unique identifier for this input — used in << pipeline.input.key >> templates(minLen:1)
enum
required
Input type — determines the field widget and validation rulesAllowed values:
textboolean
default:"true"
Whether this input must be provided when running the pipeline
string
Human-readable description shown in the UI when running the pipeline
string
Default value used when no value is provided at runtime
Module.ValidationPattern[]
Regex patterns the value must matchSee: Module.ValidationPattern
Module.NumberValueItem
A selectable option with a numeric value. Used in number input validation.values arrays.string
Text shown in the dropdown — defaults to value if omitted
string
Extra detail shown alongside the option
string
Groups options under a shared heading in the dropdown
integer
required
Actual number sent to Terraform when this option is selected(format:int32)
Module.ShowWhen
Only show this option when another field has a specific valueSee: Module.ShowWhen
Module.ValidationPattern
A regex pattern with an error message for validationstring
required
JavaScript regex the input must match
string
required
Error shown to the user when validation fails
Module.StringValueItem
A selectable option with a string value. Used in string input validation.values arrays.string
Text shown in the dropdown — defaults to value if omitted
string
Extra detail shown alongside the option
string
Groups options under a shared heading in the dropdown
string
required
Actual value sent to Terraform when this option is selected
Module.ShowWhen
Only show this option when another field has a specific valueSee: Module.ShowWhen
Module.ShowWhen
Conditional visibility mapping; array source values support contains and contains-all matching. Keys are property names, values are the expected values or conditions. The property is shown only when all conditions are met.Type: map<string,Module.ShowWhenCondition>Module.ShowWhenCondition
A show_when condition.One of: string | integer | boolean | string | integer | boolean[], Module.ShowWhenNotCondition, Module.ShowWhenPatternsCondition.Module.ShowWhenComparableValue
Value or values to compare against in a show_when condition; arrays mean membership for scalar sources and contains-all for array sources. When the source value is scalar, an array condition matches any listed value. When the source value is an array, a scalar condition matches if the array contains that value. When the source value is an array, an array condition matches if the array contains all listed values.One of: string | integer | boolean, string | integer | boolean[].Module.ShowWhenNotCondition
Negated show_when condition.string | integer | boolean | string | integer | boolean[]
required
Show the property only when the source value does not match this condition.
Module.ShowWhenPatternsCondition
Regex condition for string values; holds when the string matches every ECMAScript regular expression in the list, like input patterns.string[]
required
Show the property only when the source string matches every ECMAScript regular expression in this list.