使用 Systems Manager 自动化文档 - AWS Toolkit for VS Code
假设和先决条件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 文档，用于执行常见的维护和部署任务，如创建或更新亚马逊机器映像（AMI）。本主题概述了如何通过 AWS Toolkit for Visual Studio Code 创建、编辑、发布和删除自动化文档。

主题

假设和先决条件

在您开始之前，请确保：

Systems Manager 自动化文档的 IAM 权限

在 Toolkit for VS Code 中，您必须拥有一个凭证配置文件，其中包含创建、编辑、发布和删除 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 策略。有关如何设置凭证配置文件的信息，请参阅 AWS IAM 凭证。

创建新的 Systems Manager 自动化文档

您可以在 JSON 或 YAML 中使用 Visual Studio Code 创建新的自动化文档。当您创建新的自动化文档时，它将显示在无标题文件中。您可以为文件命名并将其保存在 VS Code 中，但是该文件的名称在 AWS 中不可见。

创建新的自动化文档

  1. 打开 VS Code。

  2. 在视图菜单中，选择命令面板以打开“命令面板”。

  3. 在“命令面板”中，输入 AWS Toolkit 在本地创建新的 Systems Manager 文档。

  4. 为 Hello World 示例选择其中一个初学者模板。

  5. 选择 JSON 或 YAML。

    新的自动化文档已成功创建。

注意

您在 VS Code 中创建的新自动化文档不会自动显示在 AWS 中。您必须将其发布至 AWS 后方可运行。

打开现有的 Systems Manager 自动化文档

您可以使用 AWS Explorer 查找现有的 Systems Manager 自动化文档。当您打开现有的自动化文档后，它将在 VS Code 中显示为无标题文件。

打开自动化文档

  1. 打开 VS Code。

  2. 从左侧导航栏中，选择 AWS 以打开 AWS Explorer。

  3. 在 AWS Explorer 中，对于 Systems Manager，选择要打开的文档上的下载图标，然后选择文档版本。该文件将以该版本的格式打开。或者，您也可以选择以 JSON 格式下载或以 YAML 格式下载。

注意

在 VS Code 中将自动化文档保存为本地文件，不会使其显示在 AWS 中。在执行之前，需要将其发布到 AWS。

编辑 Systems Manager 自动化文档

如果您拥有任何自动化文档，则它们会显示在 AWS Explorer 中 Systems Manager 文档的我拥有的类别中。您可以拥有 AWS 中已存在的自动化文档，也可以拥有之前从 VS Code 发布到 AWS 的新文档或更新后的文档。

当您在 VS Code 中打开自动化文档进行编辑时，您可以利用它完成的操作会比在 AWS Management Console中更多。例如：

  • JSON 和 YAML 格式均有架构验证。

  • 文档编辑器中有一些代码段可供您创建任何自动化步骤类型。

  • JSON 和 YAML 中的各种选项都支持自动完成。

使用版本

Systems Manager 自动化文档使用版本进行变更管理。您可以在 VS Code 中为 Systems Manager 自动化文档选择默认版本。

要设置默认版本

  • 在 AWS Explorer 中，导航到要设置默认版本的文档，请打开该文档的上下文(右键单击)菜单，然后选择 Set default version（设置默认版本）。

    注意

    如果选择的文档只有一个版本，则无法更改默认版本。

发布 Systems Manager 自动化文档

在 VS Code 中编辑自动化文档后，您可以将其发布到 AWS。

发布您的自动化文档

  1. 打开您想要使用打开现有的 Systems Manager 自动化文档中概述的流程进行发布的自动化文档。

  2. 执行您想要发布的更改。有关更多信息，请参阅 编辑 Systems Manager 自动化文档。

  3. 在打开文件的右上角，选择上传图标。

  4. 在“发布工作流程”对话框中，选择要将自动化文档发布到的 AWS 区域。

  5. 如果您要发布新文档，请选择快速创建。或者，您也可以选择快速更新，以在该 AWS 区域中更新现有的自动化文档。

  6. 输入此自动化文档的名称。

当您向 AWS 发布对现有自动化文档的更新时，系统会为该文档添加一个新版本。

删除 Systems Manager 自动化文档

您可以删除 VS Code 中的自动化文档。删除自动化文档将删除该文档以及该文档的所有版本。

重要

  • 删除是一个无法撤消的破坏性操作。

  • 删除已经运行的自动化文档不会删除启动时创建或修改的 AWS 资源。

删除您的自动化文档

  1. 打开 VS Code。

  2. 从左侧导航栏中，选择 AWS 以打开 AWS Explorer。

  3. 在 AWS Explorer 中，针对 Systems Manager，打开要删除的文档的上下文（右键单击）菜单，然后选择删除文档。

删除 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 中创建新的资源，并可能产生账单费用。我们强烈建议您在启动自动化文档之前先了解自动化文档将在您的账户中创建什么。