Variable Configuration

Examples

Options Documentation

Listed below is the full set of supported variable configuration options with documentation on the corresponding behavior.

• name
  type: string, required - no defaults
  The name of this configured variable that will be used in the task and debug configurations.
  The name can only consist of alpha-numeric characters and underscore.

• type
  type: 'text' | 'list', required - no defaults
  Determines the mode of user input used for the variable substitution.
  text asks the user to type their input in a prompt, and list asks the user to select a choice from a user-specified list.

• description
  type: string, defaults to ''
  A brief description for the variable providing context for the user during input.

• default_text
  type: string, defaults to ''
  The default text for the input prompt where the user types their input.
  This option is only valid for text type variables.

• choice_list
  type: string[], required - no defaults
  The list of choices provided to the user to select from for substitution.
  This option is only valid for list type variables.