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

ステートマネージャー

メンテナンスウィンドウ

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

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

  • AWS-ConfigureAWSPackage

  • AWS-RunPatchBaseline

  • AWS-RunPatchBaselineAssociation

  • AWS-RunShellScript

自動化ドキュメント

オートメーション

ステートマネージャー

メンテナンスウィンドウ

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

Linux ベースのオペレーティングシステム用にサポートされているオートメーションドキュメントはすべて、macOS 向けの EC2 インスタンスでもサポートされています。

パッケージドキュメント

ディストリビューター

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

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

セッションドキュメント

AWS Systems Manager

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

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

  • AWS-PasswordReset

  • AWS-StartInteractiveCommand

  • AWS-StartPortForwardingSession

  • AWS-StartPortForwardingSessionToSocket

  • AWS-StartSSHSession

ポリシードキュメント

ステートマネージャー

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

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

Change Calendar ドキュメント

Change Calendar

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

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

AWS CloudFormation テンプレート

AWS CloudFormation

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

現在、CloudFormation テンプレートは AWS コマンドラインツールから Systems Manager ドキュメントとしてのみ作成できます。

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

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

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

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

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

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

ドキュメントのタグ付け

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

ドキュメントの共有

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

SSM ドキュメントクォータ

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