Parameter Constraints

This section explains the format of constraints in the parameters section.

Using constraints it is possible to define restrictions for input parameters.

As an example, the following type of usage becomes possible.

  • Setting of limits on the length of user name strings and the characters that can be used.
constraints:
  - <constraint type>: <constraint definition>
    description: <constraint description>
Element Required Description
<constraint type> Yes

Specifies the type of constraint.

  • length
  • range
  • allowed_values
  • allowed_pattern
<constraint definition> Yes Specifies the definition of a constraint in the format corresponding to its type.
description No Defines the message that is displayed for the user when a constraint is violated. If omitted, the default message will be used.

<constraint type> and <constraint definition> are described in the section below.