Step Functions Workflow Studio でのワークフローの開発 - AWS Step Functions
デザインモードコードモード設定モード

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Step Functions Workflow Studio でのワークフローの開発

の Workflow Studio を使用すると AWS Step Functions、キャンバスに drag-and-drop を記述してワークフローを視覚的に構築できます。状態を視覚的に追加および編集したり、入力フィルターと出力フィルターを設定したり、結果を変換したり、エラー処理を設定したりできます。

ワークフローの状態を変更すると、Workflow Studio はステートマシン定義を検証して自動生成します。生成されたコードを確認し、設定を編集し、組み込みのコードエディタでテキスト定義を変更することもできます。完了したら、ワークフローを保存して実行し、結果を確認できます。

ワークフローを作成または編集するときに、Step Functions コンソールから Workflow Studio にアクセスできます。

ビジュアルデザイナーである 内から Workflow Studio を使用してAWS Application Composer、 と で AWS Serverless Application Model コードとしてのインフラストラクチャを作成することもできますAWS CloudFormation。このアプローチの利点については、「」を参照してくださいApplication Composer の Workflow Studio を使用する。

注記

Workflow Studio は Internet Explorer 11 をサポートしていないため、別のブラウザを選択する必要があります。

Workflow Studio には、設計 、コード 、設定 の 3 つのモードがあります。設計モードでは、キャンバスに drag-and-drop を記述できます。コードモードには、コンソール内でワークフロー定義を編集するための組み込みコードエディタが用意されています。設定モードでは、ワークフロー設定を管理できます。

デザインモード

設計モードは、プロトタイプを構築するワークフローを視覚化するためのグラフィカルインターフェイスを提供します。次の画像は、Workflow Studio の設計モードの状態ブラウザ、ワークフローキャンバス、インスペクター、コンテキストヘルプパネルを示しています。

状態ブラウザ、ワークフローキャンバス、インスペクター、ヘルプパネルを示す設計モードのスクリーンショット。

  1. モードボタンは 3 つのモードを切り替えます。ASL ワークフロー定義が無効である場合、モードを切り替えることはできません。

  2. [State browser] (状態ブラウザ) には次の 3 つのタブがあります。

    • Actions タブには、キャンバスの AWS APIsワークフローグラフにドラッグアンドドロップできる のリストが表示されます。各アクションは タスクワークフローの状態 状態を示します。

    • [フロー] タブは、キャンバス内のワークフローのグラフにドラッグアンドドロップできるフロー状態のリストを表示します。

    • パターンタブには ready-to-use、さまざまなユースケースに使用できる再利用可能な構成要素がいくつか用意されています。例えば、これらのパターンを使用して Amazon S3 バケットのデータを繰り返し処理できます。

  3. Canvas とワークフローのグラフ は、状態をワークフローのグラフにドラッグアンドドロップし、状態の順序を変更します。状態を選択して、状態を設定または表示に選択します。

  4. Inspector パネル パネルでは、キャンバス上で選択した任意の状態のプロパティを表示および編集できます。[定義] トグルをオンにすると、現在選択されているステートが強調表示された状態で、ワークフローの Amazon States Language コードが表示されます。

  5. [Info] (情報) リンクは、ヘルプが必要になるとコンテキスト情報を含むパネルを開きます。これらのパネルには、Step Functions ドキュメントの関連トピックへのリンクも含まれます。

  6. デザインツールバー - 元に戻す、削除、ズームインなどの一般的なアクションを実行するボタンのセットが含まれています。

  7. ユーティリティボタン – ワークフローの保存や、そのASL定義を JSONまたは YAML ファイルにエクスポートするなどのタスクを実行するためのボタンのセット。

[State browser] (状態ブラウザ)

ステートブラウザから、ワークフローキャンバスにドラッグアンドドロップするステートを選択できます。Actions タブには、サードパーティーのHTTPエンドポイント および に接続するタスク状態のリストが表示されます AWS APIs。フロータブには、ワークフローを指示および制御できる状態のリストが表示されます。フローの状態には、選択、並列、マップ、合格、待機、成功、失敗が含まれます。パターンタブには ready-to-use、再利用可能な事前定義された構成要素が表示されます。パネルの上部にある検索ボックスを使用して、すべての状態タイプを検索できます。

アクション、フロー、パターン、検索を示すスクリーンショットのコレクション。

Canvas とワークフローのグラフ

ワークフローに追加する状態を選択したら、キャンバスにドラッグしてワークフローグラフにドロップできます。状態をドラッグアンドドロップしてワークフロー内を移動することもできます。ワークフローが大きい場合は、ズームインまたはズームアウトして、ワークフローグラフのさまざまな部分をキャンバスに表示できます。

Inspector パネル

右側の Inspector パネルからワークフローに追加する状態を設定できます。設定する状態を選択すると、[Inspector] パネルにその設定オプションが表示されます。ワークフローコードの自動生成されたASL定義を表示するには、定義の切り替えをオンにします。選択した状態に関連付けられたASL定義が強調表示されます。

設定パネルを示す Workflow Studio インスペクターのスクリーンショット
コード定義を示す Workflow Studio インスペクターパネルのスクリーンショット

コードモード

Workflow Studio のコードモードでは、統合されたコードエディタを使用して、Step Functions コンソール内でワークフローの Amazon States Language を使用した Step Functions ワークフローの定義 (ASL) 定義を表示、書き込み、編集できます。次のスクリーンショットは、 コードモードのコンポーネントを示しています。

コードモードでワークフロー定義を編集するスクリーンショット。

  1. モードボタンは 3 つのモードを切り替えます。ASL ワークフロー定義が無効である場合、モードを切り替えることはできません。

  2. コードエディタ は、Workflow Studio 内でワークフローASLの定義を記述および編集する場所です。コードエディタには、構文の強調表示やオートコンプリートなどの機能もあります。

  3. グラフの視覚化 - ワークフローをリアルタイムでグラフィカルに可視化します。

  4. ユーティリティボタン – ワークフローの保存や、そのASL定義を JSONまたは YAML ファイルにエクスポートするなどのタスクを実行するためのボタンのセット。

  5. コードツールバー - アクションの取り消しやコードのフォーマットなど、一般的なアクションを実行するためのボタンのセットが含まれています。

  6. グラフツールバー - ワークフローグラフのズームインやズームアウトなど、一般的なアクションを実行するためのボタンセットが含まれています。

コードエディタ

コードエディタは、Workflow Studio JSON内で を使用してワークフロー定義を記述および編集するための IDEのようなエクスペリエンスを提供します。コードエディタには、構文の強調表示、オートコンプリートの提案、ASL定義の検証、コンテキストに応じたヘルプの表示など、いくつかの機能が含まれています。ワークフロー定義を更新すると、グラフの視覚化 はワークフローのリアルタイムグラフをレンダリングします。更新されたワークフローグラフは、デザインモード でも確認できます。

デザインモード またはグラフの視覚化ペインで状態を選択すると、その状態ASLの定義がコードエディタで強調表示されます。設計モードまたはグラフの視覚化ペインで状態を並べ替え、削除、または追加すると、ワークフローASLの定義が自動的に更新されます。

コードエディタは、フィールドと状態を自動入力するように提案できます。

  • 特定のステートに含めることができるフィールドのリストを表示するには、Ctrl+Space を押します。

  • ワークフローで新しい状態のコードスニペットを生成するには、現在の状態の定義のCtrl+Space後に を押します。

  • 使用可能なすべてのコマンドとキーボードショートカットのリストを表示するには、 を押しますF1。

グラフの視覚化

グラフの視覚化パネルには、ワークフローがグラフィカル形式で表示されます。Workflow Studio の コードエディタ でワークフロー定義を記述すると、グラフ表示ペインにワークフローのリアルタイムグラフが表示されます。

可視化ペインでステートの順序を変更、削除、または複製すると、コードエディタのワークフロー定義が自動的に更新されます。同様に、コードエディタでワークフロー定義の更新、順序の変更、削除、ステートの追加を行うと、可視化も自動的に更新されます。

ワークフローJSONASLの定義の が無効の場合、グラフの視覚化パネルはレンダリングを一時停止し、ペインの下部にステータスメッセージを表示します。

設定モード

Workflow Studio の Config モードでは、ステートマシンの一般的な設定を管理できます。このモードでは、次のような設定を指定できます。

  • 詳細： ワークフロー名とタイプを設定します。ステートマシンの作成後は、両方を変更できないことに注意してください。

  • アクセス許可: 新しいロールを作成する (推奨）、既存のロールを選択する、または特定のロールARNの を入力できます。新しいロールを作成するオプションを選択すると、Step Functions は最小特権を使用してステートマシンの実行ロールを作成します。生成されたIAMロールは、ステートマシンを作成する AWS リージョン に対して有効です。作成前に、Step Functions がステートマシンに自動的に生成するアクセス許可を確認できます。

  • ログ記録： ステートマシンのログレベルを有効にして設定できます。Step Functions は、選択内容に基づいて実行履歴イベントを記録します。オプションで、カスタマーマネージドキーを使用してログを暗号化できます。ログレベルの詳細については、「Step Functions 実行イベントのログレベル」を参照してください。

追加設定 では、次のオプション設定オプションを 1 つ以上設定できます。

  • X-Ray トレースを有効にする: トレース ID がアップストリームサービスによって渡されない場合でも、ステートマシンの実行X-Rayのためにトレースを に送信できます。詳細については、「の Step Functions リクエストデータをトレースする AWS X-Ray」を参照してください。

  • [作成時にバージョンを発行]: バージョンとは、実行可能なステートマシンの番号が付けられた変更不可能なスナップショットです。ステートマシンの作成中にステートマシンのバージョンを発行するには、このオプションを選択します。Step Functions は、ステートマシンの最初のリビジョンとしてバージョン 1 を発行しています。バージョンの詳細については、「Step Functions ワークフローのステートマシンバージョン」を参照してください。

  • カスタマーマネージドキーで暗号化: データを暗号化するために直接管理するキーを指定できます。詳細については、「保管中のデータ暗号化」を参照してください。

  • タグ : このボックスを選択すると、リソースに関連するコストを追跡および管理し、IAMポリシーのセキュリティを向上させるのに役立つタグを追加できます。タグの詳細については、Step Functions でのステートマシンとアクティビティのタグ付けを参照してください。