チュートリアル: ビジュアルデザインエクスペリエンスを使用したランブックの作成
このチュートリアルでは、Systems Manager Automation が提供するビジュアルデザインエクスペリエンスを使用した作業の基本について学習します。ビジュアルデザインエクスペリエンスでは、複数のアクションを使用するランブックを作成できます。ドラッグアンドドロップ機能を使用して、キャンバス上のアクションを整理します。また、これらのアクションを検索、選択、設定することもできます。次に、ランブックのワークフロー用に自動生成された YAML コードを表示したり、ビジュアルデザインエクスペリエンスを終了したり、ランブックを実行したり、実行の詳細を確認したりできます。
このチュートリアルでは、ランブックを更新して新しいバージョンを表示する方法も説明します。チュートリアルを最後までやると、クリーンアップステップを実行し、ランブックを削除します。
このチュートリアルを完了すると、ビジュアルデザインエクスペリエンスを使用してランブックを作成する方法がわかります。また、ランブックを更新、実行、削除する方法もわかります。
注記
このチュートリアルを開始する前に、オートメーションの設定 を完了していることを確認してください。
トピック
ステップ 1: ビジュアルデザインエクスペリエンスに移動
-
Systems Manager オートメーションコンソール
にサインインします。 -
[オートメーションを作成] を選択してランブックを保存します。
ステップ 2: ワークフローを作成する
ビジュアルデザインエクスペリエンスでは、ワークフローはランブックをキャンバス上にグラフィカルに表示したものです。ビジュアルデザインエクスペリエンスを使用して、ランブックの個々のアクションを定義、設定、および検証できます。
ワークフローを作成するには
-
[デザイン] と [コード] トグルの横にある鉛筆アイコンを選択し、ランブックの名前を入力します。このチュートリアルでは、
VisualDesignExperienceTutorialと入力します。
-
[フォーム] パネルの [ドキュメント属性] セクションで、[入力パラメーター] ドロップダウンを展開し、[パラメーターを追加] を選択します。
-
[パラメータ名] セクションに「
InstanceId」と入力します。 -
[タイプ] ドロップダウンで、[AWS:: EC2:: インスタンス] を選択します。
-
[必須] トグルを選択します。
-
-
[AWSAPI] ブラウザで検索バーに「
DescribeInstances」と入力します。 -
[Amazon EC2 — DescribeInstances] アクションを空のキャンバスにドラッグします。
-
[名前] に値を入力します。このチュートリアルでは、名として
GetInstanceStateを使用します。
-
[その他の入力] ドロップダウンを展開し、[入力名] フィールドに「
InstanceIds」と入力します。 -
[入力] タブを選択します。
-
[入力値] フィールドで、
InstanceId文書入力を選択します。これは、プロシージャの最初に作成した入力パラメータの値を参照します。DescribeInstancesアクションの InstanceIds 入力はStringList値を受け入れるため、InstanceId 入力を角括弧で囲む必要があります。[入力値] の YAML は['{{ InstanceId }}']と一致する必要があります。 -
[出力] タブで [出力を追加] を選択し、[名前] フィールドに
InstanceStateを入力します。 -
[セレクター] フィールドに、
$.Reservations[0].Instances[0].State.Nameと入力します。 -
[タイプ] ドロップダウンで [文字列] を選択します。
-
-
[アクション] ブラウザーから [ブランチ] アクションをドラッグし、
GetInstanceStateステップの下にドロップします。 -
[名前] に値を入力します。このチュートリアルでは、名前
BranchOnInstanceState分岐ロジックを定義するには、次の手順を実行します。
-
Branchキャンバス上の状態を選択します。次に、[入力] と [選択肢] で鉛筆アイコンを選択し、[ルール #1] を編集します。 -
[条件を追加] を選択します。
-
[ルール #1 の条件] ダイアログボックスで、[変数] ドロップダウンから
GetInstanceState.InstanceStateステップ出力を選択します。 -
[演算子] で、[次と等しい] を選択します。
-
[値] には、ドロップダウンリストから [文字列] を選択します。
stoppedと入力します。
-
[条件を保存] を選択します。
-
[新しいルールを追加] を選択します。
-
[ルール #2] の [条件を追加] を選択します。
-
[ルール #2 の条件] ダイアログボックスで、[変数] ドロップダウンから
GetInstanceState.InstanceStateステップ出力を選択します。 -
[演算子] で、[次と等しい] を選択します。
-
[値] には、ドロップダウンリストから [文字列] を選択します。
stoppingと入力します。 -
[条件を保存] を選択します。
-
[新しいルールを追加] を選択します。
-
[ルール #3] で [条件を追加] を選択します。
-
[ルール #3 の条件] ダイアログボックスで、[変数] ドロップダウンから
GetInstanceState.InstanceStateステップ出力を選択します。 -
[演算子] で、[次と等しい] を選択します。
-
[値] には、ドロップダウンリストから [文字列] を選択します。
runningと入力します。 -
[条件を保存] を選択します。
-
[デフォルトルール] で、[デフォルトステップ] の [最後まで進む] を選択します。
-
-
{{ GetInstanceState.InstanceState }} == "stopped" 条件の下にある空の [インスタンス状態を変更] アクションを、空の [ここにドラッグ] ボックスにドラッグします。
-
[ステップ名] には、と入力します。
StartInstance -
[入力] タブの [インスタンス ID] で、ドロップダウンから [InstanceId] ドキュメントの入力値を選択します。
-
[希望する状態] には
runningを指定します。
-
-
{{ GetInstanceState.InstanceState }} == "stopping" 条件の下にある空の [AWSリソースを待つ] アクションを、空の [ここにドラッグ] ボックスにドラッグします。
-
[名前] に値を入力します。このチュートリアルでは、名前
WaitForInstanceStop-
[サービス] フィールドには [Amazon EC2] を選択します。
-
[API] フィールドでは、[DescribeInstances] を選択します。
-
[プロパティセレクター] フィールドには、
$.Reservations[0].Instances[0].State.Nameと入力します。 -
[希望値] パラメータには、
["stopped"] -
[WaitForInstanceStop] アクションの [設定] タブで、[次のステップ] ドロップダウンから [インスタンスを開始] を選択します。
-
-
{{ GetInstanceState.InstanceState }} == "running" 条件の下にある空の [インスタンスでコマンドを実行] アクションを、空の [ここにドラッグ] ボックスにドラッグします。
-
[ステップ名] には、と入力します。
SayHello-
[入力] タブで、[ドキュメント名] パラメータに「
AWS-RunShellScript」と入力します。 -
[InstanceIds] については、ドロップダウンから [InstanceId] ドキュメントの入力値を選択します。
-
[追加入力] ドロップダウンを展開し、[入力名] ドロップダウンで [パラメータ] を選択します。
-
[値入力] フィールドに
{"commands": "echo 'Hello World'"}
-
-
完成したランブックをキャンバスで確認し、[ランブック作成] を選択してチュートリアルランブックを保存します。
ステップ 3: 自動生成されたコードを確認する
[アクション] ブラウザーからキャンバスにアクションをドラッグアンドドロップすると、ビジュアルデザインエクスペリエンスによってランブックの YAML または JSON コンテンツがリアルタイムで自動的に作成されます。このコードは表示および編集できます。自動生成されたコードを表示するには、[デザイン] と [コード] トグルの [コード] を選択します。
ステップ 4: 新しいランブックを実行する
ランブックを作成したら、オートメーションを実行できます。
新しい自動化ランブックを実行するには
AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/
) を開きます。 -
ナビゲーションペインで、[オートメーション]、[オートメーションの実行] の順に選択します。
-
[Automation document (自動化ドキュメント)] リストで、ランブックを選択します。[Document categories (ドキュメントカテゴリ)] ペインで 1 つ以上のオプションを選択して、目的に応じて SSM ドキュメントをフィルタリングします。自分が所有するランブックを表示するには、[Owned by me (自分が所有)] タブを選択します。自分のアカウントと共有されているランブックを表示するには、[Shared with me (共有ファイル)] タブを選択します。すべてのランブックを表示するには、[すべてのドキュメント] タブを選択します。
注記
ランブックの名前を選択すると、ランブックに関する情報を表示できます。
-
[Document details (ドキュメントの詳細)] セクションで、[Document version (ドキュメントのバージョン)] が実行するバージョンに設定されていることを確認します。システムには、次のバージョンのオプションが含まれています。
-
[ランタイムのデフォルトバージョン]: 自動化ランブックが定期的に更新され、新しいデフォルトバージョンが割り当てられている場合は、このオプションを選択します。
-
[ランタイムの最新バージョン]: 自動化ランブックが定期的に更新され、直前に更新されたバージョンを実行する場合は、このオプションを選択します。
-
[1 (デフォルト)]: ドキュメントの最初のバージョンを実行するには、このオプションを選択します。これはデフォルト設定です。
-
-
[Next] を選択します。
-
[オートメーションランブックの実行] セクションで、[シンプルな実行] を選択します。
[Input parameters (入力パラメータ)] セクションで、必要な入力を指定します。必要に応じて、[AutomationAssumeRole] リストから IAM サービスロールを選択できます。
-
(オプション) モニタリング用のオートメーションに適用する Amazon CloudWatch アラームを選択します。CloudWatch アラームをオートメーションにアタッチするには、コマンドを実行する IAM プリンシパルに
iam:createServiceLinkedRoleアクションの権限が必要です。CloudWatch アラームの詳細については、「Amazon CloudWatch でのアラームの使用」を参照してください。アラームが作動すると、オートメーションは停止されます。AWS CloudTrail を使用する場合、トレイルに API コールが表示されます。 -
[実行] を選択します。
ステップ 5：クリーンアップ
ランブックを削除するには
AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/
) を開きます。 ナビゲーションペインで、[ドキュメント] を選択します。
-
[自分が所有] タブを選択します。
-
[ビジュアルデザインエクスペリエンスチュートリアル] のランブックを探してください。
-
ドキュメントカードページのボタンを選択し、[アクション] ドロップダウンから [ドキュメントを削除] を選択します。
