Parameter Constraints

parametersセクションのconstraintsの書式について説明します。

constraintsを利用することにより、入力するパラメータに制約を定義することができます。

例として、以下の様な利用ができます。

  • ユーザー名の文字列長や使用可能文字列の制約を設定する
constraints:
  - <constraint type>: <constraint definition>
    description: <constraint description>
Element Required Description
<constraint type> Yes

制約のタイプを指定します。

  • length
  • range
  • allowed_values
  • allowed_pattern
<constraint definition> Yes 制約の定義をタイプに対応する書式で指定します。
description No 制約に違反したときにユーザーに表示されるメッセージを定義します。省略した場合は、デフォルトのメッセージが指定されます。

<constraint type>および<constraint definition>について以下の節で説明します。