メニュー
Amazon EC2 Systems Manager
ユーザーガイド

Systems Manager ドキュメントの作成

Systems Manager パブリックドキュメントによってマネージドインスタンスで実行するアクションが制限されている場合、独自のドキュメントを作成できます。新しいドキュメントを作成する場合は、スキーマバージョン 2.0 以降を使用することをお勧めします。Systems Manager ドキュメントには、以下のセクションが含まれています。

  • schemaVersion: 使用するスキーマバージョン。

  • Description: ドキュメントの目的を説明するために提供する情報。

  • Parameters: ドキュメントが受け入れるパラメータ。コマンドなど。頻繁に使用するパラメータを簡単に参照するには、{{ssm:parameter_name}} 形式のパラメータストアパラメータを使用します。詳細については、「Systems Manager パラメータストア」を参照してください。

  • mainSteps: 複数のステップ (プラグイン) を含めることができるオブジェクト。ステップには、1 つまたは複数のアクション、アクションの一意の名前、これらのアクションの入力 (パラメータ) が含まれます。詳細については、「SSM プラグイン」 (Amazon EC2 Systems Manager API Reference) を参照してください。

Systems Manager の必須セクションの例を次に示します。

Copy
{ "schemaVersion":"2.0", "description":"Run a script", "parameters":{ "commands":{ "type":"StringList", "description":"(Required) Specify a shell script or a command to run.", "minItems":1, "displayType":"textarea" } }, "mainSteps":[ { "action":"aws:runShellScript", "name":"runShellScript", "inputs":{ "commands":"{{ commands }}" } }, { "action":"aws:runPowerShellScript", "name":"runPowerShellScript", "inputs":{ "commands":"{{ commands }}" } } ] }

注記

現在、ポリシードキュメントで同じプラグインを 2 回使用することはできません。

ドキュメントを作成する際に、ドキュメントのコンテンツは JSON で指定します。JSON の使用を開始する最も簡単な方法は、Systems Manager パブリックドキュメントのいずれかから既存のサンプルをコピーすることです。

Systems Manager ドキュメントをコピーするには

  1. Amazon EC2 コンソールで、[Systems Manager Shared Resources] を展開し、[Documents] を選択します。

  2. ドキュメントを選択します。

  3. 下部のペインで、[Content] タブを選択します。

  4. JSON をテキストエディタにコピーして、カスタムドキュメントの詳細を指定します。

  5. ファイルを、.json ファイル拡張子を付けてドキュメントを保存します。

ドキュメントのコンテンツを作成した後、以下の手順のいずれかを使用して Systems Manager に追加できます。

注記

ポリシードキュメントを作成した場合は、システムに追加した後、そのドキュメントをマネージドインスタンスに関連付ける必要があります。詳細については、「ステートマネージャー の関連付け」を参照してください。

Amazon EC2 コンソールを使用した Systems Manager ドキュメントの追加

  1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

  2. ナビゲーションペインで、[Documents] を選択します。

  3. [Create Document] を選択します。

  4. ドキュメントの記述名を入力します

  5. [Document Type] リストで、作成するドキュメントのタイプを選択します。

  6. [Content] フィールドのかっこを削除した後に、先に作成したドキュメントを貼り付けます。

  7. [Create Document] を選択してドキュメントを保存します。

Windows PowerShell を使用した Systems Manager ドキュメントの追加

  1. 先に説明されているように、既存のドキュメントをコピーし、カスタマイズします。

  2. AWS Tools for Windows PowerShell を使用してドキュメントを追加します。

    Copy
    $json = Get-Content C:\your file | Out-String New-SSMDocument -Name document name -Content $json

AWS CLI を使用した Systems Manager ドキュメントの追加

  1. 先に説明されているように、既存のドキュメントをコピーし、カスタマイズします。

  2. AWS CLI を使用してドキュメントを追加します。

    Copy
    aws ssm create-document --content file://path to your file\your file --name "document name" --document-type "Command"

    Windows の例

    Copy
    aws ssm create-document --content file://c:\temp\PowershellScript.json --name "PowerShellScript" --document-type "Command"

    Linux の例

    Copy
    aws ssm create-document --content file:///home/ec2-user/RunShellScript.json --name "RunShellScript" --document-type "Command"