ドキュメントビルダーを使用したランブックの作成 - AWS Systems Manager

ドキュメントビルダーを使用したランブックの作成

AWS Systems Manager の公開ランブックが、AWS リソースで実行するすべてのアクションをサポートしない場合、独自のランブックを作成できます。カスタムランブックを作成するには、適切なオートメーションアクションを含むローカルの JavaScript Object Notation (JSON) または YAML 形式のファイルを手動で作成します。または、Systems Manager コンソールでドキュメントビルダーを使用して、カスタムランブックを構築できます。

ドキュメントビルダーを使用すると、JSON または YAML 構文を使用しなくても、オートメーションアクションステップをカスタムランブックに追加し、必要なパラメータを指定できます。ステップを追加してランブックを作成すると、追加したアクションが、Systems Manager がオートメーションの実行に使用できる YAML 形式に変換されます。

ランブックでは、マークアップ言語である Markdown の使用がサポートされています。これにより、wiki スタイルの説明をランブックやランブック内の個々のステップに追加できます。Markdown の使用に関する詳細については、「AWS での Markdown の使用」を参照してください。

ヒント

このトピックでは、サポートされているアクションタイプでドキュメントビルダーを使用するための一般的な情報を提供します。スクリプトを実行するランブックの作成の詳細については、以下のトピックを参照してください。

開始する前に

ドキュメントビルダーを使用してカスタムオランブックを作成する前に、ランブック内で使用できるさまざまなアクションについて読むことをお勧めします。詳細については、「」を参照してくださいSystems Manager Automation アクションのリファレンス

ドキュメントビルダーを使用してランブックを作成するには

  1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

  2. ナビゲーションペインで、[ドキュメント] を選択します。

    -または-

    AWS Systems Manager ホームページが最初に開く場合は、メニューアイコン ( ) を選択してナビゲーションペインを開き、[ドキュメント] を選択します。

  3. [Create automation (オートメーションを作成)] を選択します。

  4. [名前] に、ランブックのわかりやすい名前を入力します。

  5. [Document description (ドキュメントの説明)] に、ランブックのマークダウンスタイルの説明を入力します。ランブック、番号付きステップ、またはその他の種類の情報を使用してランブックを説明できます。コンテンツの書式設定については、デフォルトのテキストを参照してください。

    ヒント

    [Hide preview (プレビューを非表示)] と [Show preview (プレビューを表示)] を切り替えて、作成時に説明の内容がどのように表示されるかを確認します。

  6. (オプション) [Assume role (ロールの継承)] に、ユーザーに代わってアクションを実行するサービスロールの名前または ARN を入力します。ロールを指定しない場合、オートメーションはオートメーションを実行するユーザーのアクセス許可を使用します。

    重要

    aws:executeScript アクションを使用する Amazon が所有していないランブックの場合、ロールを指定する必要があります。詳細については、ランブックを使用するためのアクセス許可 を参照してください。

  7. (オプション) [Outputs (出力)] に、このランブックを実行するための出力を入力して、他のプロセスで使用できるようにします。

    たとえば、ドキュメントが新しい AMI を作成する場合、["CreateImage.ImageId"] を指定し、この出力を使用して後続のオートメーションで新しいインスタンスを作成します。

  8. (オプション) [Input parameters (入力パラメータ)] セクションを展開し、次の操作を行います。

    1. [Parameter name (パラメータ名)] に、作成するランブックパラメータのわかりやすい名前を入力します。

    2. [Type (タイプ)] で、パラメータのタイプ(StringMapList など)を選択します。

    3. [Required (必須)] で、次のいずれかの操作を行います。

      • ランタイムにこのランブックパラメータの値を指定する必要がある場合は、[Yes (はい)] を選択します。

      • パラメータが不要な場合は、[No (いいえ)] を選択し、(オプション) [Default value (デフォルト値)] にデフォルトのパラメータ値を入力します。

    4. [Description (説明)] に、ランブックパラメータの説明を入力します。

    注記

    ランブックパラメータをさらに追加するには、[Add a parameter (パラメータを追加)] を選択します。ランブックパラメータを削除するには、[X] (削除) ボタンを選択します。

  9. (オプション) [Target type (ターゲットタイプ)] セクションを展開し、ターゲットタイプを選択して、オートメーションが実行できるリソースの種類を定義します。たとえば、EC2 インスタンスでランブックを使用するには、/AWS::EC2::Instance を選択します。

    注記

    /」の値を指定すると、ランブックはすべてのタイプのリソースで実行できます。有効なリソースタイプのリストについては、AWS CloudFormation ユーザーガイドAWS リソースタイプのリファレンスをご参照ください。

  10. (オプション) [Document tags (ドキュメントタグ)] セクションを展開し、ランブックに適用するタグキーと値のペアを 1 つ以上入力します。タグを使用すると、リソースの識別、整理、検索が容易になります。詳細については、「」を参照してくださいシステムマネージャのドキュメントにタグを付ける

  11. [Step 1 (ステップ 1)] セクションで、次の情報を入力します。

    • [Step name (ステップ名)] に、オートメーションの最初のステップのわかりやすい名前を入力します。

    • [Action type (アクションタイプ)] で、このステップで使用するアクションタイプを選択します。

      使用可能なアクションタイプのリストと情報については、「Systems Manager Automation アクションのリファレンス」を参照してください。

    • [Description (説明)] に、オートメーションステップの説明を入力します。Markdown を使用してテキストの書式を設定できます。

    • 選択した [Action type (アクションタイプ)] に応じて、[Step inputs (ステップ入力)] セクションにアクションタイプに必要な入力を入力します。たとえば、アクション aws:approve を選択した場合は、Approvers プロパティの値を指定する必要があります。

      ステップ入力フィールドの詳細については、選択したアクションタイプの「Systems Manager Automation アクションのリファレンス」のエントリを参照してください。例: aws:executeStateMachine – AWS Step Functions ステートマシンを実行する

    • (オプション) [Additional inputs (追加入力)] で、ランブックに必要な追加の入力値を指定します。使用可能な入力タイプは、ステップで選択したアクションタイプによって異なります。(一部のアクションタイプには入力値が必要です)。

      注記

      さらに入力を追加するには、[Add optional input (オプションの入力を追加)] を選択します。入力を削除するには、[X] (削除)ボタンを選択します。

    • (オプション) [Outputs (入力)] に、このステップの出力を入力して、他のプロセスで使用できるようにします。

      注記

      [Outputs (出力)] は、すべてのアクションタイプで使用できるわけではありません。

    • (オプション) [Common properties (共通プロパティ)] セクションを展開し、すべてのオートメーションアクションに共通するアクションのプロパティを指定します。例えば、[Timeout seconds (タイムアウト秒)] には、ステップが停止するまでの実行時間を指定するための値を秒単位で指定できます。

      詳細については、「」を参照してくださいすべてのアクションで共有されるプロパティ

    注記

    ステップをさらに追加するには、[Add step (ステップを追加)] を選択し、ステップを作成する手順を繰り返します。ステップを削除するには、[Remove step (ステップを削除)] を選択します。

  12. [Create automation (オートメーションを作成)] を選択してランブックを保存します。