使用 Systems Manager 自動化文件 - AWS 適用於 VS 程式碼的工具組
假設和先決條件Systems Manager 自動化文件的 IAM 許可建立新的 Systems Manager 自動化文件開啟現有的 Systems Manager 自動化文件編輯 Systems Manager 自動化文件發佈 Systems Manager 自動化文件刪除 Systems Manager 自動化文件執行 Systems Manager 自動化文件

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 Systems Manager 自動化文件

AWS Systems Manager 可讓您了解和控制 上的基礎設施 AWS。Systems Manager 提供統一的使用者介面，讓您可以檢視來自多個 AWS 服務的操作資料，並自動化 AWS 資源的操作任務。

Systems Manager 文件定義 Systems Manager 在受管執行個體上執行的動作。自動化文件是一種 Systems Manager 文件，可用來執行常見的維護和部署任務，例如建立或更新 Amazon Machine Image (AMI)。本主題概述如何使用 建立、編輯、發佈和刪除自動化文件 AWS Toolkit for Visual Studio Code。

主題

假設和先決條件

在開始之前，請確認：

Systems Manager 自動化文件的 IAM 許可

在 Toolkit for VS Code 中，您必須擁有登入資料設定檔，其中包含建立、編輯、發佈和刪除 Systems Manager Automation 文件所需的 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 政策。如需如何設定登入資料設定檔的資訊，請參閱 AWS IAM 登入資料。

建立新的 Systems Manager 自動化文件

您可以在 JSONYAML中或使用 Visual Studio Code 建立新的自動化文件。當您建立新的自動化文件時，它會以無標題的檔案顯示。您可以命名檔案並將其儲存在 VS 程式碼中，但檔案的名稱無法顯示 AWS。

建立新的自動化文件

  1. 開啟 VS 程式碼。

  2. 在檢視功能表上，選擇命令調色盤以開啟命令調色盤。

  3. 在命令面板中，輸入 AWS Toolkit Create a new Systems Manager Document Locally。

  4. 為 Hello World 範例選擇其中一個入門範本。

  5. 選擇 JSON 或 YAML。

    建立新的自動化文件。

注意

VS Code 中的新自動化文件不會自動出現在 中 AWS。您必須先將其發佈至 ， AWS 才能執行它。

開啟現有的 Systems Manager 自動化文件

您可以使用 AWS Explorer 來尋找現有的 Systems Manager Automation 文件。當您開啟現有的自動化文件時，它會在 VS 程式碼中顯示為無標題檔案。

開啟自動化文件

  1. 開啟 VS 程式碼。

  2. 從左側導覽中，選擇 AWS以開啟 AWS Explorer。

  3. 在 AWS Explorer 中，針對 Systems Manager，選擇您要開啟的文件上的下載圖示，然後選擇文件版本。檔案將以該版本的格式開啟。否則，請選擇下載為 JSON 或下載為 YAML。

注意

在本機將自動化文件儲存為 VS 程式碼中的檔案，不會使其出現在 中 AWS。在執行 AWS 之前，它需要發佈到 。

編輯 Systems Manager 自動化文件

如果您擁有任何自動化文件，它們會出現在 AWS Explorer 中 Systems Manager 文件的「由我擁有」類別中。您可以擁有已存在於 中的自動化文件 AWS，也可以擁有先前 AWS 從 VS 程式碼發佈至 的新文件或更新的文件。

當您開啟要在 VS 程式碼中編輯的自動化文件時，可以使用它執行的作業會比在 中執行的更多 AWS Management Console。例如：

  • JSON 和 YAML 格式都有結構描述驗證。

  • 文件編輯器中有可用的程式碼片段，可讓您建立任何自動化步驟類型。

  • JSON 和 中的各種選項都有自動完成支援YAML。

處理版本

Systems Manager Automation 文件使用版本進行變更管理。您可以在 VS 程式碼中選擇自動化文件的預設版本。

設定預設版本

  • 在 AWS Explorer 中，導覽至您要設定預設版本的文件，開啟文件的內容 （按一下滑鼠右鍵） 選單，然後選擇設定預設版本。

    注意

    如果選定文件只有一個版本，則將無法變更預設版本。

發佈 Systems Manager 自動化文件

在 VS 程式碼中編輯自動化文件後，您可以將文件發佈至 AWS。

發佈自動化文件

  1. 使用 中概述的程序，開啟您要發佈的自動化文件開啟現有的 Systems Manager 自動化文件。

  2. 進行您要發佈的變更。如需詳細資訊，請參閱編輯 Systems Manager 自動化文件。

  3. 在開啟檔案的右上角，選擇上傳圖示。

  4. 在發佈工作流程對話方塊中，選擇您要發佈自動化文件 AWS 的區域。

  5. 如果您要發佈新文件，請選擇快速建立。否則，請選擇快速更新以更新該 AWS 區域中現有的自動化文件。

  6. 輸入此自動化文件的名稱。

當您將更新發佈至現有的自動化文件時 AWS，文件會新增新版本。

刪除 Systems Manager 自動化文件

您可以在 VS 程式碼中刪除自動化文件。刪除自動化文件會同時刪除該文件及其所有版本。

重要

  • 刪除是一種破壞性動作，而且無法復原。

  • 刪除已執行的自動化文件不會刪除 AWS 啟動時建立或修改的資源。

刪除自動化文件

  1. 開啟 VS 程式碼。

  2. 從左側導覽中，選擇 AWS以開啟 AWS Explorer。

  3. 在 AWS Explorer 中，針對 Systems Manager，開啟您要刪除之文件的內容 （按一下滑鼠右鍵） 選單，然後選擇刪除文件。

執行 Systems Manager 自動化文件

將自動化文件發佈至 後 AWS，您就可以執行它，以代表您在 AWS 帳戶中執行任務。若要執行自動化文件，您可以使用 AWS Management Console、APIs、 AWS CLI或 AWS Tools for PowerShell。如需如何執行自動化文件的說明，請參閱AWS Systems Manager 《 使用者指南》中的執行簡單的自動化。

或者，如果您想要搭配 Systems Manager APIs AWS SDKs 來執行自動化文件，請參閱 AWS SDK 參考。

注意

執行自動化文件可以在 中建立新的資源， AWS 並可能產生帳單成本。強烈建議您先了解自動化文件在帳戶中建立的內容，再開始。