AWS Systems Manager
ユーザーガイド

SSM ドキュメントスキーマと機能

現在 Systems Manager ドキュメントでは以下のスキーマバージョンを使用しています。

  • Command タイプのドキュメントは、スキーマバージョン 1.2、2.0 および 2.2 を使用できます。現在使用しているドキュメントがスキーマ 1.2 である場合は、スキーマバージョン 2.2 を使用するドキュメントを作成することをお勧めします。

  • Policy タイプのドキュメントは、スキーマバージョン 2.0 以降を使用する必要があります。

  • Automation タイプのドキュメントは、スキーマバージョン 0.3 を使用する必要があります。

  • JSON あるいは YAML でドキュメントを作成できます。

Command および Policy ドキュメントで最新バージョンのスキーマを使用することで、次の機能を利用できます。

スキーマバージョン 2.2 ドキュメントの機能

機能 詳細

ドキュメントの編集

ドキュメントは更新可能になりました。バージョン 1.2 では、ドキュメントを更新した場合に別の名前で保存する必要がありました。

バージョンの自動管理

ドキュメントを更新すると新しいバージョンが作成されます。これはスキーマのバージョンではなく、ドキュメントのバージョンです。

デフォルトバージョン

ドキュメントに複数のバージョンがある場合、どのバージョンがデフォルトのドキュメントかを指定できます。

順序付け

ドキュメントのプラグインまたはステップを指定した順序で実行します。

クロスプラットフォームのサポート

クロスプラットフォームをサポートすることで、同じ SSM ドキュメント内で異なるプラグインに異なるオペレーティングシステムを指定できます。クロスプラットフォームのサポートはステップ内の precondition パラメータを使用します。

注記

新しい Systems Manager 機能および SSM ドキュメント機能を使用するには、インスタンスの SSM エージェント を常に最新バージョンに更新しておく必要があります。詳細については、「Run Command を使用して SSM エージェント を更新する」を参照してください。

次の表はスキーマのメジャーバージョン間の相違点の一覧です。

バージョン 1.2 バージョン 2.2 (最新バージョン) 詳細

runtimeConfig

mainSteps

バージョン 2.2 では、runtimeConfig の代わりに mainSteps セクションを使用します。mainSteps セクションでは、Systems Manager がステップを順番に実行できるようになります。

プロパティ

inputs

バージョン 2.2 では、properties セクションの代わりに inputs セクションを使用します。inputs セクションは、ステップのパラメータを受け入れます。

commands

runCommand

バージョン 2.2 では、inputs セクションは runCommand パラメータを使用します。commands パラメータは使用しません。

id

action

バージョン 2.2 では、ID の代わりに Action を使用します。これは名前のみの変更です。

該当なし

name

バージョン 2.2 では、name はステップの任意のユーザー定義名です。

前提条件パラメータを使用する

スキーマバージョン 2.2 以降では、precondition パラメータを使用して各プラグインのターゲットオペレーティングシステムを指定できます。precondition パラメータは platformType、および Windows または Linux いずれかの値をサポートします。

スキーマバージョン 2.2 以降を使用するドキュメントの場合、precondition が指定されていないと、各プラグインはそのプラグインとオペレーティングシステムとの互換性に基づいて実行またはスキップされます。スキーマ 2.0 以前を使用するドキュメントの場合は、互換性のないプラグインはエラーをスローします。

たとえば、スキーマバージョンが 2.2 のドキュメントで、precondition が指定されておらず aws:runShellScript プラグインがリストされている場合、そのステップは Linux インスタンスで実行されますが、Windows インスタンスではシステムによってスキップされます。これは、aws:runShellScript が Windows インスタンスと互換性がないためです。しかし、スキーマバージョンが 2.0 のドキュメントでは、aws:runShellScript プラグインを指定して、ドキュメントを Windows インスタンスで実行した場合、実行は失敗します。SSM ドキュメントでの前提条件パラメータの例は後でこのセクションで確認できます。