AWS Systems Manager ドキュメント
AWS Systems Manager ドキュメント (SSM ドキュメント) は、Systems Manager がマネージドインスタンスで実行するアクションを定義します。Systems Manager には、ランタイムでパラメータを指定して使用できる事前設定済みのドキュメントが 100 件以上含まれています。Systems Manager のドキュメントコンソールの、[Owned by Amazon] (Amazon 所有) タブを選択するか、ListDocuments API オペレーションを呼び出す際に Owner フィルターで Amazon を指定することで、事前設定済みのドキュメントを確認できます。ドキュメントは JavaScript Object Notation (JSON) や YAML を使用し、これにはユーザーが指定するパラメータおよびステップが含まれます。
セキュリティを強化するため、SSM ドキュメントでは、2025 年 7 月 14 日からパラメータ処理時に環境変数補間がサポートされるようになりました。この機能はスキーマバージョン 2.2 および SSM Agent バージョン 3.3.2746.0 以降で利用でき、コマンドインジェクション攻撃の防止に役立ちます。
SSM ドキュメントの使用を開始するには、Systems Manager コンソール
重要
Systems Manager において、Amazon 所有の SSM ドキュメントとは、Amazon Web Services 自体によって作成および管理されているドキュメントです。Amazon 所有のドキュメントでは、ドキュメント名に AWS-* のようなプレフィックスが含まれます。ドキュメントの所有者は、AWS 内の特定のユーザーアカウントではなく Amazon と見なされます。これらのドキュメントは公開されており、誰でも使用できます。
ドキュメントツールには自社の組織にどのようなメリットがありますか?
ドキュメントには次のようなメリットがあります。
-
ドキュメントのカテゴリ
必要なドキュメントを検索しやすくするには、検索するドキュメントの種類に応じてカテゴリを選択します。検索範囲を広げる場合は、同じドキュメントタイプに対して複数のカテゴリを選択できます。異なるドキュメントタイプに関するカテゴリの選択はサポートされていません。カテゴリーは、Amazon が所有するドキュメントでのみ使用できます。
-
ドキュメントのバージョン
ドキュメントの異なるバージョンを作成して保存できます。その後、各ドキュメントのデフォルトのバージョンを指定できます。ドキュメントのデフォルトバージョンは、新しいバージョンに更新したり、古いバージョンのドキュメントに戻すことができます。ドキュメントのコンテンツを変更すると、Systems Manager は自動的にドキュメントのバージョンを増やします。コンソール、AWS Command Line Interface (AWS CLI) コマンド、または API コールでドキュメントバージョンを指定することで、ドキュメントの任意のバージョンを取得または使用できます。
-
必要に応じてドキュメントをカスタマイズする
ドキュメントのステップやアクションをカスタマイズする場合は、独自のドキュメントを作成できます。システムが、それが作成された AWS リージョン 内の AWS アカウント により、ドキュメントを保存します。SSM ドキュメントの作成方法の詳細については、「SSM ドキュメントコンテンツを作成する」を参照してください。
-
タグのドキュメント
ドキュメントにタグを付けると、そのタグに基づいてドキュメントをすばやく識別できます。たとえば、特定の環境、部門、ユーザー、グループ、または期間でドキュメントをタグ付けできます。ユーザーやグループがアクセスできるタグを指定する AWS Identity and Access Management (IAM) ポリシーを作成することで、ドキュメントへのアクセスを制限することもできます。
-
ドキュメントの共有
ドキュメントを公開するか、または同じ AWS リージョン の特定の AWS アカウント と共有できます。例えば、顧客または従業員に提供するすべての Amazon Elastic Compute Cloud (Amazon EC2) インスタンスに同じ設定を適用したい場合などは、アカウント間でドキュメントを共有すると便利です。これは、インスタンス上のアプリケーションまたはパッチを最新の状態に保つことに加えて、顧客のインスタンスで特定のアクティビティを拒否したい場合にも利用できます。または、組織全体の従業員アカウントで使用されているインスタンスに、特定の内部リソースへのアクセス許可が確実に付与されるようにする場合があります。詳細については、「SSM ドキュメントの共有」を参照してください。
ドキュメントを使用すべきユーザー
-
大規模な運用での効率改善、手動による介入が原因で起きうるエラー数の削減、一般的な問題の解決までの時間の短縮などに、AWS Systems Manager ツールの使用をお考えのすべてのお客様。
-
デプロイおよび設定タスクを自動化しようとするインフラストラクチャの専門家。
-
一般的な問題の確実な解決、トラブルシューティングの効率向上、および反復処理の削減を希望する管理者。
-
通常手動で実行しているタスクの自動化を目指すユーザー。
SSM ドキュメントの種類について教えてください。
次の表に、各タイプの SSM ドキュメントと、それらの用途についての説明を示します。
| タイプ | 以下で使用 | 詳細 |
|---|---|---|
|
ApplicationConfiguration ApplicationConfigurationSchema |
AWS AppConfig を使用すると、アプリケーション設定の作成、管理、迅速なデプロイが可能です。 SSM ドキュメントで設定を作成する場合は、対応する JSON スキーマを指定する必要があります。スキーマは |
|
|
Automation ランブック |
Amazon Machine Image (AMI) の作成や更新など、一般的なメンテナンスやデプロイメントタスクを実行する際に、Automation ランブックを使用します。State Manager は、Automation ランブックを使用して設定を適用します。これらのアクションは、インスタンスのライフサイクル中いつでも 1 つ、または複数のターゲットで実行できます。Maintenance Windowsは、指定されたスケジュールに基づいた一般的なメンテナンスタスクとデプロイメントタスクの実行に Automation ランブックを使用します。 Linux ベースのオペレーティングシステム用にサポートされているAutomation ランブックはすべて、macOS 向けの EC2 インスタンスでもサポートされています。 |
|
|
Change Calendar ドキュメント |
Change Calendar は Change Calendar は、macOS の EC2 インスタンスではサポートされていません。 |
|
|
AWS CloudFormation テンプレート |
AWS CloudFormation テンプレートは、CloudFormation スタックでプロビジョニングするリソースについて記述します。CloudFormation テンプレートを Systems Manager のドキュメントとして保存すると、Systems Manager のドキュメント機能のメリットを活用できます。これには、複数のバージョンのテンプレートの作成と比較、同じ AWS リージョン の他のアカウントとのテンプレートの共有が含まれます。 Application Manager を使用すれば、CloudFormation のテンプレートとスタックの作成と編集が可能です。詳細については、「Application Manager での CloudFormation テンプレートとスタックの使用」を参照してください。 |
|
|
コマンドのドキュメント |
Run Command はコマンドドキュメントを使用してコマンドを実行します。State Managerはコマンドドキュメントを使用して設定を適用します。これらのアクションは、インスタンスのライフサイクル中にいつでも、1 つまたは複数のターゲットで実行できます。Maintenance Windows は、指定されたスケジュールに基づいて設定を適用するためにコマンドドキュメントを使用します。 ほとんどのコマンドドキュメントは、Systems Manager でサポートされているすべての Linux および Windows Server オペレーティングシステムでサポートされています。macOS 向けの EC2 インスタンスでは、以下のコマンドドキュメントがサポートされています。
|
|
|
AWS Config コンフォーマンスパックテンプレート |
AWS Config コンフォーマンスパックテンプレートは YAML 形式のドキュメントで、AWS Config マネージドルールまたはカスタムルールおよび修復アクションのリストを含むコンフォーマンスパックを作成するために使用されます。 詳細については、「コンフォーマンスパック」を参照してください。 |
|
|
パッケージドキュメント |
Distributor では、パッケージは SSM ドキュメントで表されます。パッケージドキュメントには、マネージドインスタンスにインストールするソフトウェアまたはアセットを含む添付 ZIP アーカイブファイルが含まれています。Distributor でパッケージを作成するパッケージドキュメントを作成します。 Distributor は、Oracle Linux および macOS マネージドインスタンスではサポートされていません。 |
|
|
ポリシードキュメント |
Inventory は、State Manager の関連付けがある Systems Manager Inventory と |
|
|
インシデント後分析テンプレート |
Incident Manager は、インシデント後分析テンプレートを使用して、AWS オペレーション管理のベストプラクティスに基づいて分析を作成します。 御社のチームは、テンプレートを使用して作成した分析を、インシデント対応での改善点を特定するために使用できます。 |
|
|
セッションドキュメント |
Session Manager はセッションドキュメントを使用して、開始するセッションのタイプを決定します。例としては、ポート転送セッション、インタラクティブコマンドセッション、SSH トンネルなどがあります。 セッションドキュメントは、Systems Manager でサポートされているすべての Linux および Windows Server オペレーティングシステムでサポートされています。macOS 向けの EC2 インスタンスでは、以下のコマンドドキュメントがサポートされています。
|
SSM ドキュメントクォータ
SSM ドキュメントのクォータの詳細については、「Amazon Web Services 全般のリファレンス」の「Systems Manager Service Quotas」を参照してください。
