ワークフロードキュメントでは動的変数を使用します

ワークフロードキュメントで動的変数を使用して、イメージ作成プロセスのランタイム時に変化する値を表すことができます。動的変数の文字列補間を使用すると、JSON 文字列などの構造化コンテンツ内に JSONPath 式を埋め込むことができます。これは、複雑なペイロード内のランタイム値を ExecuteStateMachineや などのステップアクションに渡す必要がある場合に特に便利ですWaitForAction。

動的変数に文字列補間を使用するには、文字列コンテンツ"{{...}}"内の二重中括弧で JSONPath 式をラップします。二重中括弧でラップされた JSONPath 式のみが変数として処理されます。二重中括弧でラップされていない JSONPath 式は、リテラル文字列コンテンツとして扱われます。

JSONPath 動的ワークフロー変数構文

$.<document structure>.[<step name>.]<variable name>

動的変数値は、ターゲット変数を一意に識別する構造ノードを備えた JSONPath セレクターとして表されます。ルート ($) の後の最初のノードは、stepOutputs または Image Builder システム変数の場合は、imageBuilder などのワークフロードキュメント構造を表します。以下のリストには、サポートされている JSONPath ワークフロードキュメント構造ノードが含まれています。

parameters および stepOutputs ドキュメント構造ノードには、ステップ名のオプションノードが含まれます。これにより、すべてのステップで変数名が一意になるようになります。

JSONPath の最後のノードは、instanceId などのターゲット変数の名前です。

各ステップは、これらの JSONPath 動的変数を備えた前のステップアクションの出力を参照できます。これをチェーニング、または参照とも呼びます。前のステップアクションの出力を参照するには、次の動的変数を使用できます。

$.stepOutputs.step-name.output-name

例 1: 入力パラメータ連鎖インジケータ

次の例は、文字列補間を使用して実行時にパラメータ値の動的変数を解決する入力パラメータを示しています。

  - name: ApplyTestComponents
    action: ExecuteComponents
    onFailure: Abort
    inputs:
      instanceId.$: "$.stepOutputs.LaunchTestInstance.instanceId"

例 2: 動的変数の文字列補間

次の例は、動的変数が文字列補間を使用して実行時に値を決定する方法を示しています。

- name: ValidateImageConfiguration
  action: ExecuteStateMachine
  inputs:
    stateMachineArn: arn:aws:states:us-east-1:111122223333:stateMachine:ImageValidation
    input: |
      {
        "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}",
        "region": "us-east-1",
        "buildDate": "{{ $.imagebuilder.dateTime }}",
        "instanceType": "{{ $.stepOutputs.LaunchStep.instanceType }}"
      }

この例では、二重中括弧でラップされた JSONPath 式は実行時に解決されます。

のようなリテラル文字列"region": "us-east-1"は変更されません。

Image Builder システム変数を使用する

Image Builder には、ワークフロードキュメントで使用できる以下のシステム変数があります。