Parameters

All workflows, except destroy, can accept parameters. Parameters are defined as an ordered list in the workflow definition’s parameters section. The parameter order in the list indicates how parameters are displayed to the user.

Each parameter has:

A parameter can optionally restrict possible values by providing an enum attribute, which can be a list of possible values or a dictionary from human-readable labels to possible values.

Syntax

parameters:
  - [param-name]:
    type: [param-type]
    description: [param-label]  # optional; if not set, param-name will be used
    default: [param-default]    # optional
    enum:                       # optional; if both default and enum exist, they must be consistent with each other
      [value-label-1]: [value-1]
      [value-label-2]: [value-2]
      ...
    ...
  - ...

Platform supports the following types for workflow parameters:

  • primitive: bool, int, string, double
  • collections: map, list

String Parameters

Syntax:

parameters:
  - [param-name]:
    type: string
    description: [param-label]  # optional; if not set, param-name will be used
    default: [param-default]    # optional; must be a string if present
    length:                     # optional
      min: [min-length]         # optional
      max: [max-length]         # optional
  - ...

Integer Parameters

Syntax:

parameters:
  - [param-name]:
    type: int
    description: [param-label]  # optional; if not set, param-name will be used
    default: [param-default]    # optional
    min: [min-value]            # optional
    max: [max-value]            # optional
  - ...