ビジュアルデザインエクスペリエンスの活用 - AWS Systems Manager
ランブックワークフローを作成するランブックを作成するランブックを更新するランブックのエクスポート

ビジュアルデザインエクスペリエンスの活用

ビジュアルデザインエクスペリエンスを使用してランブックワークフローを作成、編集、実行する方法を学習します。ワークフローの準備ができたら、ワークフローをエクスポートできます。ビジュアルデザインエクスペリエンスを使用して、ラピッドプロトタイプ作成を行うこともできます。

ランブックワークフローを作成する

  1. Systems Manager Automation コンソールにサインインします。

  2. [ランブックの作成] を選択します。

  3. [名前] ボックスに、ランブックの名前を入力します。例:MyNewRunbook

  4. [デザイン] と [コード] トグルの横にある鉛筆アイコンを選択し、ランブックの名前を入力します。

これで、新しいランブックのワークフローをデザインできます。

ランブックを作成する

ビジュアルデザインエクスペリエンスを使用してランブックワークフローをデザインするには、[アクション] ブラウザーからキャンバスにオートメーションアクションをドラッグし、ランブックのワークフロー内の目的の場所に配置します。また、ワークフロー内の別の場所にドラッグして、ワークフローのアクションを並べ替えることができます。アクションをキャンバスにドラッグすると、ワークフロー内でドロップできる場所にラインが表示されます。キャンバスにアクションがドロップされると、そのコードが自動生成され、ランブックのコンテンツ内に追加されます。

追加したいアクションの名前がわかっている場合は、[アクション] ブラウザの上部にある検索ボックスを使用して、アクションを検索します。

アクションをキャンバスにドロップしたら、右側の [フォーム] パネルを使用してアクションを設定します。このパネルには、キャンバスに配置した各オートメーションアクションまたは API アクションの [一般]、[入力]、[出力]、および [設定]タブがあります。例えば、[一般] タブは次のセクションで構成されています。

  • [ステップ名] はステップを識別します。ステップ名に一意の値を指定します。

  • [説明] は、アクションがランブックのワークフローで何をしているのかを説明するのに役立ちます。

[入力] タブには、アクションによって異なるフィールドがあります。例えば、aws:executeScript オートメーションアクションには以下のセクションがあります。

  • [ランタイム] は、指定されたスクリプトの実行に使用する言語です。

  • [ハンドラー] は、関数の名前です。ハンドラで定義された関数に、events と context の 2 つのパラメータがあることを確認する必要があります。PowerShell ランタイムはこのパラメータをサポートしていません。

  • [スクリプト] は、ワークフローで実行する埋め込みスクリプトです。

  • (オプション) [添付ファイルは]、アクションによって呼び出せるスタンドアロンスクリプトまたは.zip ファイル用です。このパラメータは、JSON ランブックでは必須です。

[出力] タブは、アクションから出力する値を指定するのに役立ちます。ワークフローの後のアクションで出力値を参照したり、アクションからの出力を生成してログに記録したりできます。すべてのアクションがアウトプットをサポートしているわけではないため、すべてのアクションに [出力] タブがあるわけではありません。例えば、aws:pause アクションは出力をサポートしていません。出力をサポートするアクションの場合、[出力] タブは次のセクションで構成されます。

  • [名前] は出力値に使用される名前です。出力はワークフローの後のアクションで参照できます。

  • [セレクター] は、"$." から始まる JSONPath 式文字列で、JSON 要素内の 1 つまたは複数のコンポーネントを選択するために使用されます。

  • [タイプ] は出力値のデータ型です。例えば、String または Integer データタイプと入力します。

[設定] タブには、すべてのオートメーションアクションで使用できるプロパティとオプションが含まれています。アクションには次のセクションがあります。

  • [最大試行数] プロパティは、失敗した場合にアクションが再試行される回数です。

  • [タイムアウト秒] プロパティは、アクションのタイムアウト値を指定します。

  • [致命的か] プロパティは、アクションが失敗したためにオートメーション全体が停止するかどうかを決定します。

  • [次のステップ] プロパティは、ランブック内でオートメーションが次に実行するアクションを決定します。

  • [失敗時] プロパティは、アクションが失敗した場合にオートメーションがランブックで次に実行するアクションを決定します。

  • [キャンセル時] プロパティは、アクションがユーザーによってキャンセルされた場合に、オートメーションがランブックで次に実行するアクションを決定します。

アクションを削除するには、キャンバスの上にあるツールバーの Backspace を使用するか、右クリックして [アクションを削除] を選択します。

ワークフローが大きくなると、キャンバスに収まらない場合があります。ワークフローがキャンバスに収まるようにするには、以下のオプションのいずれかを実行します。

  • サイドパネルのコントロールを使用して、パネルのサイズを変更するか、パネルを閉じます。

  • キャンバスの上部にあるコントロールを使用して、ワークフローのグラフをズームインまたはズームアウトします。

ランブックを更新する

ランブックの新しいバージョンを作成することで、既存のランブックワークフローを更新できます。ランブックを更新するには、ビジュアルデザインエクスペリエンスを使用するか、コードを直接編集します。既存のランブックを更新するには、以下の手順に従います。

  1. Systems Manager Automation コンソールにサインインします。

  2. 更新するランブックを選択します。

  3. [Create new version (新しいバージョンの作成)] を選択します。

  4. ビジュアルデザインエクスペリエンスには、コードペインとビジュアルワークフローペインの 2 つのペインがあります。ビジュアルワークフローペインで [デザイン] を選択して、ビジュアルデザインエクスペリエンスでワークフローを編集します。完了したら、[新しいバージョンを作成] を選択して変更を保存し、終了します。

  5. (オプション) コードペインを使用して、YAML または JSON のランブックコンテンツを編集します。

ランブックのエクスポート

ランブックのワークフロー YAML または JSON コード、およびワークフローのグラフをエクスポートするには、以下の手順に従います。

  1. [ドキュメント] コンソールでランブックを選択します。

  2. [Create new version (新しいバージョンの作成)] を選択します。

  3. [アクション] ドロップダウンで、グラフとランブックのどちらをエクスポートするか、またどの形式を好むかを選択します。