Skip to main content

Legend

Inputs

Input configuration defining the module’s form fields

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,ShowWhenCondition>

StringValues

String values - either a static array of options or a dynamic reference.One of: StringValueItem[], string.

ValidationPattern

A regex pattern with an error message for validation
string
required
JavaScript regex the input must match
string
required
Error shown to the user when validation fails

CompoundFieldValue

Allowed value types within a compound value item. Supports primitive types plus string arrays.One of: string, number, integer, boolean, string[].

CompoundValues

Compound values - either a static array of options or a dynamic reference.Note: CEL validation ensures values is provided (compound requires values).One of: CompoundValueItem[], string.

DefaultValueRef

Special default references derived from the field’s values list.Allowed values:
  • $values:first

Pipeline.GitRepoUrl

Full git repository URL including host.Type: string

NumberValues

Number values - either a static array of options or a dynamic reference.One of: NumberValueItem[], string.

ObjectArrayDefaultItem

Default value item for structured object arrays. Each array element must be an object keyed by the nested item input ids.Type: map<string,any | null>

ObjectCollectionItemTitleConfig

Configuration for the title shown for each structured collection item in the form.
string
required
Template for the item title. Supports placeholders like {key} for maps and {field_id}.
string
Fallback title template used when the primary template cannot be resolved.

MapKeyConfig

Configuration for the string key of an object_map entry.
string
Text shown for the map key field.
string
Placeholder text for a new map key.
string
Help text shown below the map key field.
ValidationPattern[]
Regex patterns to validate map keys against.See: ValidationPattern
string | null[]
Item input fields used to compute the map key instead of asking for one. Empty/null entries are ignored.
string
String used to join computed key field values. Defaults to ”-”.

RefTypeDiscriminator

Type discriminator for module references. Format: “ref:&lt;module-type&gt;" (e.g., "ref:ravion-aws-vpc”) The module type is extracted by removing the “$ref:” prefix.Type: string

ShowWhenCondition

A show_when condition.One of: string | integer | boolean | string | integer | boolean[], ShowWhenNotCondition.

DynamicValuesRef

Dynamic values reference. References an external value source resolved at runtime. Query parameters may use module input templates, e.g. $values:aws/ec2/instances?awsAccountId=<<module.input.aws_account_id>>&region=<<module.input.region>>.Type: string

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
ShowWhen
Only show this option when another field has a specific valueSee: ShowWhen

CompoundValueItem

A compound value item - a record with arbitrary fields plus select metadata. Each key maps to a field value, and includes optional display fields.Note: The actual structure is a Record with dynamic keys for the data fields, plus the optional BaseSelectFields (label, description, group_label).
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

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)
ShowWhen
Only show this option when another field has a specific valueSee: ShowWhen

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[].

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.

ShowWhenValue

Value that can be used in a show_when condition. Supports string, number, or boolean values for comparison.One of: string, integer, boolean.