システムマネージャのドキュメントにタグを付ける

このセクションのトピックでは、Systems Manager ドキュメント (SSM ドキュメント) のタグを使用する方法について説明します。

タグ付きドキュメントの作成

カスタム SSM ドキュメントを作成するときに、タグを追加できます。

詳細については、以下のトピックを参照してください。

• SSM ドキュメントを作成する (コンソール)

• SSM ドキュメントを作成する (コマンドライン)

既存のドキュメントへのタグの追加

Systems Manager コンソールまたはコマンドラインを使用して、所有しているカスタム SSM ドキュメントにタグを追加できます。

トピック

• 既存の SSM ドキュメントへのタグの追加 (コンソール)
• 既存の SSM ドキュメントへのタグの追加 (コマンドライン)

既存の SSM ドキュメントへのタグの追加 (コンソール)

1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

2. ナビゲーションペインで、[ドキュメント] を選択します。

   -または-

   AWS Systems Manager ホームページが最初に開く場合は、メニューアイコン ( ) を選択してナビゲーションペインを開き、[ドキュメント] を選択します。

3. [Owned by me (自分が所有)] タブを選択します。

4. タグを追加するドキュメントの名前を選択し、[Details (詳細)] タブを選択します。

5. [Tags (タグ)] セクションで [Edit (編集)] を選択し、1 つ以上のキーと値のタグのペアを追加します。

6. [Save] を選択します。

既存の SSM ドキュメントへのタグの追加 (コマンドライン)

既存の SSM ドキュメントへタグを追加するには (コマンドライン)

1. 任意のコマンドラインツールを使用して次のコマンドを実行することによって、タグ付けできるドキュメントの一覧を表示します。

   Linux & macOS

   aws ssm list-documents

   Windows

   aws ssm list-documents

   PowerShell

   Get-SSMDocumentList

   タグ付けするドキュメントの名前に留意してください。

2. ドキュメントにタグを付けるには、次のコマンドを実行します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

   Linux & macOS

   aws ssm add-tags-to-resource \
       --resource-type "Document" \
       --resource-id "document-name" \
       --tags "Key=tag-key,Value=tag-value"

   Windows

   aws ssm add-tags-to-resource ^
       --resource-type "Document" ^
       --resource-id "document-name" ^
       --tags "Key=tag-key,Value=tag-value"

   PowerShell

   $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag

   $tag.Key = "tag-key"

   $tag.Value = "tag-value"

   Add-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name" `
       -Tag $tag `
       -Force

   成功した場合は、コマンドの出力はありません。

3. ドキュメントのタグを確認するには、次のコマンドを実行します。

   Linux & macOS

   aws ssm list-tags-for-resource \
       --resource-type "Document" \
       --resource-id "document-name"

   Windows

   aws ssm list-tags-for-resource ^
       --resource-type "Document" ^
       --resource-id "document-name"

   PowerShell

   Get-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name"

SSM ドキュメントからタグを削除

Systems Manager コンソールまたはコマンドラインを使用して、SSM ドキュメントからタグを削除できます。

トピック

• SSM ドキュメントからタグを削除する (コンソール)
• SSM ドキュメントからタグを削除する (コマンドライン)

SSM ドキュメントからタグを削除する (コンソール)

1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

2. ナビゲーションペインで、[ドキュメント] を選択します。

   -または-

   AWS Systems Manager ホームページが最初に開く場合は、メニューアイコン ( ) を選択してナビゲーションペインを開き、[ドキュメント] を選択します。

3. [Owned by me (自分が所有)] タブを選択します。

4. タグを削除するドキュメントの名前を選択し、[Details (詳細)] タブを選択します。

5. [Tags (タグ)] セクションで [Edit (編集)] を選択し、不要になったタグペアの横にある [Remove (削除)] を選択します。

6. [Save] を選択します。

SSM ドキュメントからタグを削除する (コマンドライン)

1. 任意のコマンドラインツールを使用して次のコマンドを実行することによって、アカウント内のドキュメントの一覧を表示します。

   Linux & macOS

   aws ssm list-documents

   Windows

   aws ssm list-documents

   PowerShell

   Get-SSMDocumentList

   タグを削除するドキュメントの名前を書き留めます。

2. 次のコマンドを実行して、ドキュメントからタグを削除します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

   Linux & macOS

   aws ssm remove-tags-from-resource \
       --resource-type "Document" \
       --resource-id "document-name" \
       --tag-key "tag-key"

   Windows

   aws ssm remove-tags-from-resource ^
       --resource-type "Document" ^
       --resource-id "document-name" ^
       --tag-key "tag-key"

   PowerShell

   Remove-SSMResourceTag `
       -ResourceId "document-name" `
       -ResourceType "Document" `
       -TagKey "tag-key" `
       -Force

   成功した場合は、コマンドの出力はありません。

3. ドキュメントのタグを確認するには、次のコマンドを実行します。

   Linux & macOS

   aws ssm list-tags-for-resource \
       --resource-type "Document" \
       --resource-id "document-name"

   Windows

   aws ssm list-tags-for-resource ^
       --resource-type "Document" ^
       --resource-id "document-name"

   PowerShell

   Get-SSMResourceTag `
       -ResourceType "Document" `
       -ResourceId "document-name"