AWS ツールキットでの AWS Step Functions の使用 - AWS Cloud9
前提条件ステートマシンの作成と発行AWS ツールキットでステートマシンを実行するステートマシン定義ファイルをダウンロードし、そのワークフローを視覚化する

新規のお客様への AWS Cloud9 の提供は終了しました。AWS Cloud9 の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

AWS ツールキットでの AWS Step Functions の使用

AWS ツールキットで AWS Step Functions がサポートされます。Step Functions によって、ビジネスに不可欠なアプリケーションをサポートする AWS Lambda 関数およびその他の AWS サービスのワークフローを定義するステートマシンを作成できます。

AWS ツールキットでは、Step Functions を使用して次の操作が実行できます。

  • ステートマシンを作成して発行します。ステートマシンは、個々のステップで構成されるワークフローです。

  • ステートマシンのワークフローを定義するファイルをダウンロードします。

  • 直接入力するか、または選択した入力を使用して、ステートマシンのワークフローを実行します。

前提条件

Step Functions でコードを実行し、AWS リソース にアクセスできます (Lambda 関数の呼び出しなど)。セキュリティを維持するために、IAM ロールを使用してこれらのリソースへの Step Functions アクセスを許可する必要があります。

AWS ツールキットによって、ステートマシンを作成する AWS リージョンで有効な自動生成 IAM ロールを利用できます。ステートマシン用に独自の IAM ロールを作成する場合は、「AWS Step Functions デベロッパーガイド」の「AWS Step Functions で IAM を使用する方法」を参照してください。

ステートマシンの作成と発行

AWS ツールキットでステートマシンを作成する場合、ビジネスケース用のワークフローを定義するスターターテンプレートを選択します。それにより、テンプレートを特定のニーズに応じて編集または置き換えることができます。ステートマシンの構造を表すファイルにステートマシンを定義する方法の詳細については、「AWS Step Functions デベロッパーガイド」の「Amazon ステートメント言語」を参照してください。

  1. [AWS Explorer] ペインで、[Step Functions] のコンテキスト (右クリック) メニューを開き、[Create a new Step Function state machine] (新しい Step Function ステートマシンを作成) を選択します。

  2. コマンドパネルで、ステートマシンのワークフローのスターターテンプレートを選択します。

  3. 次に、ステートマシンを定義する Amazon ステートメント言語 (ASL、Amazon States Language) ファイルの形式を選択します。

    エディタが開き、ステートマシンのワークフローを定義する ASL ファイルが表示されます。

    注記

    ASL ファイルを編集してワークフローをカスタマイズする方法については、「ステートマシンの構造」を参照してください。

  4. ASL ファイルで、[Publish to Step Functions] (Step Functions への発行) を選択し、ステートマシンを AWS クラウドに追加します。

    注記

    ASL ファイルで [Render graph] (グラフをレンダリング) を選択して、ステートマシンのワークフローを視覚化することもできます。

    [ステップ関数に公開]を選択する方法を示す図

  5. コマンドパネルで、ステップ関数をホストする AWS リージョンを選択します。

  6. 次に、新しいステップ関数を作成するか、既存のステップ関数を更新するかを選択できます。

    Quick Create

    このオプションにより、step-functions/latest/dg/concepts-standard-vs-express.html を使用して、ASL ファイルから新しいステップ関数を作成できます。次の項目を指定する必要があります。

    • ステップ関数でのコードの実行と AWS リソースへのアクセスを許可にする IAM ロール。(ステートマシンを作成する AWS リージョンで有効な自動生成 IAM ロールを選択できます。)

    • 新しい関数の名前。

    ステートマシンが正常に作成されたことを確認し、AWS ツールキットの出力タブで ARN を取得できます。

    Quick Update

    AWS リージョンにステートマシンが既に存在する場合は、そのステートマシンを選択し、現在の ASL ファイルを使用して更新できます。

    ステートマシンが正常に更新されたことを確認し、AWS ツールキットの出力タブで ARN を取得できます。

    ステートマシンを作成すると、[AWS Explorer] ペインの [Step Functions] に表示されます。すぐに表示されない場合は、[Toolkit] (ツールキット) メニューの [Refresh Explorer] (Explorer を更新) を選択します。

AWS ツールキットでステートマシンを実行する

AWS ツールキットを使用してリモートのステートマシンを実行できます。実行状態のマシンは JSON テキストを入力として受け取り、その入力をワークフローの最初の状態に渡します。それぞれの状態で JSON を入力として受け取ります。また、通常 JSON を出力として次の状態に渡します。詳細については、「Step Functions の入出力処理」を参照してください。

  1. [AWS Explorer] ペインで、[Step Functions] を選択します。次に、特定のステートマシンのコンテキスト (右クリック) メニューを開き、[Start Execution] (実行の開始) を選択します。

  2. [Start Execution] (実行の開始) ペインで、下のフィールドに直接テキストを入力するか、ローカルデバイスからファイルをアップロードすることにより、ステートマシンのワークフローに JSON 形式入力を追加します。

  3. [Execute] (実行) を選択します。

    AWS ツールキットの出力タブに、ワークフローが開始されたことの確認とプロセス ID の ARN が表示されます。そのプロセス ID を使用して、AWS Step Functions コンソールでワークフローが正常に実行されたかどうかを確認できます。また、ワークフローの開始時刻と終了時刻のタイムスタンプを確認することもできます。

ステートマシン定義ファイルをダウンロードし、そのワークフローを視覚化する

ステートマシンをダウンロードするには、そのステートマシンの構造を表す JSON テキストを含むファイルをダウンロードします。それにより、ファイルを編集して新しいステートマシンを作成したり、既存のステートマシンを更新したりできます。詳細については、「AWS Step Functions デベロッパーガイド」の「Amazon ステートメント言語」を参照してください。

  1. [AWS Explorer] ペインで、[Step Functions] を選択します。次に、特定のステートマシンのコンテキスト (右クリック) メニューを開き、[Download Definition] (定義をダウンロード) を選択します。

    注記

    コンテキストメニューでは、[Copy Name] (名前をコピー) と [Copy ARN] (ARN をコピー) も選択できます。

  2. [Save] (保存) ダイアログボックスで、ダウンロードしたステートマシンファイルを保存する環境内のフォルダを選択し、[Save] (保存) を選択します。

    ステートマシンのワークフローを定義する JSON 形式ファイルがエディタに表示されます。

  3. ワークフローを視覚化するには、[Render graph] (グラフをレンダリング) を選択します。

    ウィンドウにフローチャートが表示され、ステートマシンのワークフロー内の状態のシーケンスが表示されます。

    ステートマシンのワークフローの視覚化