標記 Systems Manager 文件 - AWS Systems Manager

標記 Systems Manager 文件

本節中的主題說明如何在 Systems Manager 文件 (SSM 文件) 上使用標籤。

建立包含標籤的文件

您可以在建立自訂 SSM 文件時將標籤新增至其中。

如需詳細資訊,請參閱以下主題:

新增標籤至現有文件

您可以使用 Systems Manager 主控台或命令列將標籤新增至您擁有的自訂 SSM 文件。

將標籤新增到現有的 SSM 文件 (主控台)

  1. 開啟位於 AWS Systems Managerhttps://console.aws.amazon.com/systems-manager/ 的 主控台。https://console.aws.amazon.com/systems-manager/

  2. 在導覽窗格中,選擇 Documents (文件)

    -或-

    如果 AWS Systems Manager 首頁先開啟,選擇選單圖示 ( ) 以開啟導覽窗格,然後在導覽窗格中,選擇 Documents (文件)。

  3. 選擇 Owned by me (我所擁有) 索引標籤。

  4. 選擇要新增標籤的文件名稱,然後選擇 Details (詳細資訊) 索引標籤。

  5. Tags (標籤) 區段中,選擇 Edit (編輯),然後新增一或多個鍵值標籤組。

  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

    key 是您所提供之自訂索引鍵的名稱。例如,「區域」或「季度」

    tag-value 是您想為該索引鍵提供之數值的自訂內容。例如,「西部」或「Q321」

    document-name 是您想要標記之 SSM 文件的名稱。

    如果成功,命令不會有輸出。

  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 文件移除標籤 (主控台)

  1. 開啟位於 AWS Systems Managerhttps://console.aws.amazon.com/systems-manager/ 的 主控台。https://console.aws.amazon.com/systems-manager/

  2. 在導覽窗格中,選擇 Documents (文件)

    -或-

    如果 AWS Systems Manager 首頁先開啟,選擇選單圖示 ( ) 以開啟導覽窗格,然後在導覽窗格中,選擇 Documents (文件)。

  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

    document-name 是您要從中移除標籤之 SSM 文件的名稱。

    tag-key 是指派給文件的索引鍵名稱。例如,「環境」或「季度」

    如果成功,命令不會有輸出。

  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"