Systems Manager オートメーションドキュメントの使用 - AWS Cloud9

Systems Manager オートメーションドキュメントの使用

AWS Systems Manager は、AWS でご利用のインフラストラクチャを可視化し、制御するためのサービスです。Systems Manager を使用すると、統合ユーザーインターフェイスで複数の AWS サービスの運用データを確認でき、AWS リソース全体に関わる運用タスクを自動化できます。

Systems Manager ドキュメントは、マネージドインスタンスで Systems Manager が実行するアクションを定義します。オートメーションドキュメントは、Systems Manager ドキュメントの 1 つであり、共通メンテナンスや Amazon マシンイメージ (AMI) の作成と更新などのデプロイタスクを実行する際に使用します。このトピックでは、AWS ツールキットでオートメーションドキュメントを作成、編集、発行、削除する方法について説明します。

前提条件と必要事項

開始する前に、以下の事項を確認してください。

Systems Manager オートメーションドキュメントの IAM アクセス許可

Systems Manager オートメーションドキュメントの作成、編集、発行、削除に必要な AWS Identity and Access Management (IAM) アクセス許可を含む認証情報プロファイルが必要です。次のポリシードキュメントは、プリンシパルポリシーで使用可能な必須の IAM アクセス許可を定義します。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:ListDocuments", "ssm:ListDocumentVersions", "ssm:DescribeDocument", "ssm:GetDocument", "ssm:CreateDocument", "ssm:UpdateDocument", "ssm:UpdateDocumentDefaultVersion", "ssm:DeleteDocument" ], "Resource": "*" } ] }

IAM ポリシーの更新方法の詳細については、「IAM ユーザーガイド」の「IAM ポリシーの作成」を参照してください。

Systems Manager オートメーションドキュメントを新規作成する

オートメーションドキュメントは、AWS ツールキットを使用して、JSON または YAML 形式で作成できます。オートメーションドキュメントを作成すると、そのドキュメントはタイトルのないファイルに表示されます。ファイルに名前を付け、保存することはできますが、ファイルを発行するまでは AWS にアップロードされません。

オートメーションドキュメントを新規作成するには

  1. 左側のナビゲーションペインで検索アイコンを選択するか、[Ctrl+P] を押して、検索ペインを開きます。

  2. 検索ペインで、「systems manager」という語句の入力を開始し、[AWS: Create a new Systems Manager Document Locally] コマンドが表示されたら選択します。

  3. Hello World の例のスターターテンプレートのいずれかを選択します。

  4. ドキュメントの形式として、JSON または YAML を選択します。

    エディタに新しいオートメーションドキュメントが表示されます。

注記

最初にローカルでオートメーションドキュメントを作成しても、そのドキュメントは AWS に自動的には表示されません。実行するには、ドキュメントを AWS に発行する必要があります。

Systems Manager オートメーションドキュメントの発行

AWS ツールキットでオートメーションドキュメントを作成または編集すると、そのドキュメントを AWS に発行できます。

オートメーションドキュメントを発行するには

  1. 既存の Systems Manager オートメーションドキュメントの編集」の手順に従って、発行するオートメーションドキュメントを開きます。

  2. 左側のナビゲーションペインで検索アイコンを選択するか、[Ctrl+P] を押して、検索ペインを開きます。

  3. 検索ペインで、「systems manager」という語句の入力を開始し、[AWS: Publish a new Systems Manager Document ] コマンドが表示されたら選択します。

  4. [Step 1 of 3] (ステップ 1/3) で、ドキュメントを発行する AWS リージョンを選択します。

  5. [Step 2 of 3] (ステップ 2/3) で、[Quick Create] (クイック作成) を選択して、オートメーションドキュメントを作成します。または、[Quick Update] (クイック更新) を選択して、その AWS リージョンの既存のオートメーションドキュメントを更新します。

    注記

    更新できるのは、自身が所有するオートメーションドキュメントのみです。[Quick Update] (クイック更新) を選択し、リージョン内にドキュメントを所有していない場合は、更新する前にドキュメントを発行する必要があることを通知するメッセージが表示されます。

  6. [Step 3 of 3] (ステップ 3/3) で、前のステップの選択に応じて、新しいオートメーションドキュメントの名前を入力するか、更新する既存のドキュメントを選択します。

    注記

    AWS で既存のオートメーションドキュメントの更新を発行すると、新しいバージョンがドキュメントに追加されます。ドキュメントに複数のバージョンがある場合は、デフォルトのバージョンを設定できます。

既存の Systems Manager オートメーションドキュメントの編集

既存の Systems Manager オートメーションドキュメントを検索するには、AWS Explorer を使用します。既存のドキュメントを開くと、そのドキュメントはタイトルのないファイルとして AWS Cloud9 エディタに表示されます。次の 3 種類のオートメーションドキュメントをダウンロードできます。

  • Owned by Amazon (Amazon が所有): 実行時にパラメータを指定して使用できる事前設定された SSM ドキュメント。

  • Owned by me (自分が所有): 自分が作成して AWS に発行したドキュメント。

  • Shared with me (共有ファイル): ユーザーの AWS アカウント ID に基づいて、所有者がユーザーと共有しているドキュメント。

AWS で更新できるドキュメントは、owned by me (自分が所有) タイプのみです。共有タイプまたは Amazon 所有タイプのオートメーションドキュメントをダウンロードして、AWS Cloud9 で編集することもできます。ただし、AWS に発行する場合は、新しいドキュメントの作成か、所有している既存のドキュメントの更新を使用する必要があります。他のユーザーまたは Amazon が所有しているドキュメントの新規バージョンは作成できません。

詳細については、「AWS Systems Manager ユーザーガイド」の「AWS Systems Manager ドキュメントを参照してください。

  1. AWS Explorer の [Systems Manager] で、ダウンロードする SSM ドキュメントのカテゴリ ([Owned by Amazon] (Amazon が所有)、[Owned by me] (自分が所有)、[Shared with me] (共有ファイル)) を選択します。

  2. 特定のドキュメントで、コンテキスト (右クリック) メニューを開き、[Download as YAML] (YAML としてダウンロード) または [Download as JSON] (JSON としてダウンロード) を選択します。

    フォーマット済みの SSM ドキュメントが新しい編集タブに表示されます。

編集が終わったら、[AWS: Publish a new Systems Manager Document ] コマンドを使用して、AWS クラウドに新しいドキュメントを作成するか、所有している既存のドキュメントを更新できます。

バージョンの使用

Systems Manager オートメーションドキュメントでは、変更の管理にバージョンが使用されます。AWS ツールキットでは、ドキュメントの実行時に使用するデフォルトバージョンを設定できます。

デフォルトバージョンを設定するには

  • AWS Explorer で、デフォルトバージョンを有効にするドキュメントに移動し、ドキュメントのコンテキスト (右クリック) メニューを開いて、[Set default version] (デフォルトバージョンの設定) を選択します。 

    注記

    選択したドキュメントにバージョンが 1 つしかない場合は、デフォルトを変更できません。

Systems Manager オートメーションドキュメントの削除

AWS ツールキットで、所有しているオートメーションドキュメントを削除できます。オートメーションドキュメントを削除すると、ドキュメントとドキュメントのすべてのバージョンが削除されます。

重要
  • 削除は、元に戻すことができない破壊的なアクションです。

  • 既に開始されているオートメーションドキュメントを削除しても、その実行時に作成または変更された AWS リソースは削除されません。

  • 削除は、ドキュメントを所有している場合にのみ許可されます。

オートメーションドキュメントを削除するには

  1. AWS Explorer ペインの [Systems Manager] で、[Owned by Me] (自分が所有) を展開して、ドキュメントを表示します。

  2. 削除するドキュメントのコンテキスト (右クリック) メニューを開き、[Delete document] (ドキュメントの削除) を選択します。

  3. 表示される警告ダイアログボックスで、[Delete] (削除) を選択して確認します。

Systems Manager オートメーションドキュメントの実行

オートメーションドキュメントを AWS に発行すると、AWS アカウントでそのドキュメントを実行して、タスクを実行できます。オートメーションドキュメントを実行するには、AWS Management Console、Systems Manager API、AWS CLI、または AWS Tools for PowerShell を使用します。オートメーションドキュメントの実行方法については、「AWS Systems Manager ユーザーガイド」の「シンプルなオートメーションワークフローを実行する」を参照してください。

Systems Manager API を備えた AWS SDK のいずれかを使用してオートメーションドキュメントを実行する場合は、「AWS SDK リファレンス」を参照してください。

重要

オートメーショントキュメントを実行すると、AWS に新しいリソースが作成されることがあるため、料金の請求が発生する場合があります。オートメーションドキュメントを実行する前に、アカウントにどのようなリソースが作成されるかを把握することを強くお勧めします。