AWS Systems Manager ドキュメント - AWS Systems Manager

AWS Systems Manager ドキュメント

AWS Systems Manager ドキュメント (SSM ドキュメント) は、Systems Manager がマネージドインスタンスで実行するアクションを定義します。Systems Manager には、実行時にパラメータを指定して使用できる事前設定済みのドキュメントが 100 件以上含まれています。ドキュメントは JavaScript Object Notation (JSON) や YAML を使用し、これにはユーザーが指定するパラメータおよびステップが含まれます。

SSM ドキュメントのタイプ

次の表は、各タイプの SSM ドキュメントおよび説明の一覧です。

タイプ 以下で使用 詳細

コマンドのドキュメント

Run Command

ステートマネージャー

メンテナンスウィンドウ

AWS Systems Manager の一機能である Run Command はコマンドドキュメントを使用して、コマンドを実行します。AWS Systems Manager の一機能であるステートマネージャーはコマンドドキュメントを使用して、設定を適用します。これらのアクションは、インスタンスのライフサイクル中にいつでも、1 つまたは複数のターゲットで実行できます。AWS Systems Manager の一機能であるメンテナンスウィンドウでは、コマンドドキュメントを使用して、指定されたスケジュールに基づいて設定を適用します。

ほとんどのコマンドドキュメントは、Systems Manager でサポートされているすべての Linux および Windows Server オペレーティングシステムでサポートされています。macOS 向けの Amazon Elastic Compute Cloud (Amazon EC2) インスタンスでは、以下のコマンドドキュメントがサポートされています。

  • AWS-ConfigureAWSPackage

  • AWS-RunPatchBaseline

  • AWS-RunPatchBaselineAssociation

  • AWS-RunShellScript

オートメーションランブック

オートメーション

ステートマネージャー

メンテナンスウィンドウ

Amazon Machine Image (AMI) の作成や更新など、一般的なメンテナンスやデプロイメントタスクを実行する際に、Automation ランブックを使用します。ステートマネージャーは、Automation ランブックを使用して設定を適用します。これらのアクションは、インスタンスのライフサイクル中にいつでも、1 つまたは複数のターゲットで実行できます。メンテナンスウィンドウでは、Automation ランブックを使用して、指定されたスケジュールに基づいて一般的なメンテナンスとデプロイタスクを実行します。

Linux ベースのオペレーティングシステム用にサポートされているAutomation ランブックはすべて、macOS 向けの EC2 インスタンスでもサポートされています。

パッケージドキュメント

ディストリビューター

AWS Systems Manager の一機能である Distributor では、パッケージは、SSM ドキュメントで表されます。パッケージドキュメントには、マネージドインスタンスにインストールするソフトウェアまたはアセットを含む添付 ZIP アーカイブファイルが含まれています。ディストリビューターでパッケージを作成するパッケージドキュメントを作成します。

Distributor は、Oracle Linux および macOS マネージドインスタンスではサポートされていません。

セッションドキュメント

セッションマネージャー

AWS Systems Manager の一機能である Session Manager は、セッションドキュメントを使用して、ポート転送セッション、インタラクティブコマンドを実行するセッション、SSH トンネルを作成するセッションなど、開始するセッションのタイプを決定します。

セッションドキュメントは、Systems Manager でサポートされているすべての Linux および Windows Server オペレーティングシステムでサポートされています。macOS 向けの EC2 インスタンスでは、以下のコマンドドキュメントがサポートされています。

  • AWS-PasswordReset

  • AWS-StartInteractiveCommand

  • AWS-StartPortForwardingSession

  • AWS-StartPortForwardingSessionToSocket

  • AWS-StartSSHSession

ポリシードキュメント

ステートマネージャー

AWS Systems Manager の一機能である Inventory では、AWS-GatherSoftwareInventory ポリシードキュメントとステートマネージャーの関連付けを使って、マネージドインスタンスからインベントリデータを収集します。独自の SSM ドキュメントを作成するときは、Automation ランブックとコマンドドキュメントがマネージドインスタンスへのポリシーの適用に推奨される方法です。

Systems Manager Inventory と AWS-GatherSoftwareInventory ポリシードキュメントは、Systems Manager のサポート対象のすべてのオペレーティングシステムでサポートされています。

Change Calendar ドキュメント

Change Calendar

AWS Systems Manager の一機能である Change Calendar では、ChangeCalendar ドキュメントタイプが使用されています。Change Manager ドキュメントには、Automation アクションによる環境の変更を許可または禁止できるカレンダーエントリと関連するイベントが保存されます。Change Calendar では、ドキュメントは iCalendar 2.0 データをプレーンテキスト形式で保存します。

Change Calendar は、macOS の EC2 インスタンスではサポートされていません。

AWS CloudFormation テンプレート

AWS CloudFormation

AWS CloudFormation テンプレートは、CloudFormation スタックでプロビジョニングするリソースについて記述します。CloudFormation テンプレートを Systems Manager のドキュメントとして保存すると、Systems Manager のドキュメント機能のメリットを享受できます。これには、複数のバージョンのテンプレートの作成と比較、同じ AWS リージョン内の他のアカウントとのテンプレートの共有が含まれます。

Systems Manager の機能であるアプリケーションマネージャーを使用して、CloudFormation テンプレートとスタックを作成および編集できます。詳細については、「アプリケーションマネージャでの AWS CloudFormation テンプレートとスタックの使用」を参照してください。

インシデント後分析テンプレート

Incident Manager インシデント後分析

Incident Manager は、インシデント後分析テンプレートを使用して、AWS オペレーション管理のベストプラクティスに基づいて分析を作成します。

テンプレートを使用して作成した分析は、チームがインシデント対応の改善点を特定するために使うことができます。

SSM ドキュメントバージョンの使用

ドキュメントの異なるバージョンを作成して保存できます。その後、各ドキュメントのデフォルトのバージョンを指定できます。ドキュメントのデフォルトバージョンは、新しいバージョンに更新したり、古いバージョンのドキュメントに戻すことができます。ドキュメントのコンテンツを変更すると、Systems Manager は自動的にドキュメントのバージョンを増やします。コンソール、CLI コマンド、または API コールでドキュメントバージョンを指定することで、ドキュメントの任意のバージョンを取得または使用できます。

ドキュメントの内容と必須パラメータの表示

SSM ドキュメントの必須パラメータとオプションのパラメータ、およびドキュメントが実行するアクションを特定するために、Systems Manager コンソールでドキュメントのコンテンツを表示できます。詳細については、SSM コマンドドキュメントの内容の表示 を参照してください。

ドキュメントのカスタマイズ

ドキュメントのステップやアクションをカスタマイズする場合は、独自のドキュメントを作成できます。初めてドキュメントを使用してインスタンスでアクションを実行する際に、システムはドキュメントを に保存します AWS アカウント SSM ドキュメントの作成方法の詳細については、「SSM ドキュメントの作成」を参照してください。

ドキュメントのタグ付け

ドキュメントにタグを付けると、そのタグに基づいてドキュメントをすばやく識別できます。たとえば、特定の環境、部門、ユーザー、グループ、または期間でドキュメントをタグ付けできます。ユーザーやグループがアクセスできるタグを指定する AWS Identity and Access Management (IAM) ポリシーを作成することで、ドキュメントへのアクセスを制限することもできます。詳細については、「」を参照してくださいシステムマネージャのドキュメントにタグを付ける

ドキュメントの共有

ドキュメントを公開するか、または同じ AWS リージョン の特定の AWS アカウント と共有できます。たとえば、顧客または従業員に提供するすべての EC2 インスタンスを同じ設定にしたい場合、アカウント間でドキュメントを共有すると便利です。インスタンス上のアプリケーションまたはパッチを最新の状態に保つことに加えて、顧客インスタンスを特定のアクティビティから制限する必要がある場合があります。または、組織全体の従業員アカウントで使用されているインスタンスに、特定の内部リソースへのアクセス許可が確実に付与されるようにする場合があります。詳細については、「」を参照してくださいSSM ドキュメントの共有

SSM ドキュメントクォータ

SSM ドキュメントのクォータの詳細については、アマゾン ウェブ サービス全般リファレンスの「Systems Manager サービスクォータ」を参照してください。