使用 Systems Manager 自动化文档 - AWS Cloud9
假设和先决条件IAMSystems Manager 自动化文档的权限创建新的 Systems Manager 自动化文档发布 Systems Manager 自动化文档编辑现有 Systems Manager 自动化文档使用版本删除 Systems Manager 自动化文档运行 Systems Manager 自动化文档

AWS Cloud9 不再向新客户提供。 AWS Cloud9 的现有客户可以继续正常使用该服务。了解更多

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 Systems Manager 自动化文档

借 AWS Systems Manager助，您可以查看和控制您的基础架构 AWS。Systems Manager 提供了一个统一的用户界面，您可以使用该界面查看来自多个资源的操作数据， AWS 服务 并自动执行跨 AWS 资源的操作任务。

Systems Manager 文档定义 Systems Manager 对您的托管式实例执行的操作。自动化文档是一种 Systems Manager 文档，用于执行常见的维护和部署任务。这包括创建或更新 Amazon 系统映像 (AMI)。本主题概述了如何使用 AWS Toolkit 创建、编辑、发布和删除自动化文档。

主题

假设和先决条件

在开始之前，请确保您满足以下条件：

IAMSystems Manager 自动化文档的权限

要创建、编辑、发布和删除 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 Toolkit 中创建或编辑自动化文档后，您可以将其发布到 AWS。

要发布您的自动化文档

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

  2. 在左侧导航窗格中选择搜索图标或按 Ctrl+P 以打开搜索窗格。

  3. 在搜索窗格中，开始输入术语 "systems manager" 并于显示时选择 AWS: Publish a new Systems Manager Document 命令。

  4. 对于第 1 步（共 3 步），选择要发布文档 AWS 区域 的位置。

  5. 对于步骤 2（共 3 步），选择 Quick Create（快速创建）以创建一个自动化文档。或者选择 Quick Update（快速更新）以在该区域中更新现有的自动化文档。

    注意

    您只能更新您拥有的自动化文档。如果选择 Quick Update（快速更新）而且您不拥有该区域中的任何文档，会有一条消息通知您在更新文档之前发布文档。

  6. 对于步骤 3（共 3 步），根据您在上一步中的选择，输入新自动化文档的名称或选择要更新的现有文档。

    注意

    当您在中发布现有自动化文档的更新时 AWS，会向该文档中添加一个新版本。如果一个文档有多个版本，则可以设置默认版本。

编辑现有 Systems Manager 自动化文档

您可以使用 AWS 资源管理器查找现有的 Systems Manager 自动化文档。当您打开现有文档时，它会在 AWS Cloud9 编辑器中显示为无标题文件。您可以下载三种类型的自动化文档：

  • 由 Amazon 拥有：可通过在运行时指定参数来使用的预配置SSM文档。

  • 归@@ 我所有：我创建并发布到的文档 AWS。

  • 与我共享：所有者根据你的 AWS 账户 ID 与你共享的文档。

你唯一可以更新的文档类型 AWS 是那些归我所有的文档。您还可以下载亚马逊共享或拥有的自动化文档，并在 AWS Cloud9中进行编辑。但是，当您发布到时 AWS，必须使用创建新文档或更新您拥有的现有文档。您不能创建具有其他所有者或由亚马逊拥有的文档的新版本。

有关更多信息，请参阅 AWS Systems Manager 用户指南中的 AWS Systems Manager 文档。

  1. 在 AWS Explorer 中，对于 S ystems Manager，选择要下载的SSM文档类别：“亚马逊所有”、“我所有” 或 “与我共享”。

  2. 对于特定文档，打开上下文（右键单击）菜单，然后选择 “下载为” YAML 或 “下载为” JSON。

    格式化后的SSM文档将显示在新的编辑器选项卡中。

完成编辑后，您可以使用 AWS：发布新的 Systems Manager 文档命令在 AWS 云端创建新文档或更新您拥有的现有文档。

使用版本

Systems Manager 自动化文档使用版本进行变更管理。使用 AWS Toolkit，您可以设置文档的默认版本，即运行文档时使用的版本。

要设置默认版本

  • 在 AWS 资源管理器中，导航到要设置默认版本的文档，打开该文档的上下文（右键单击）菜单，然后选择设置默认版本。

    注意

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

删除 Systems Manager 自动化文档

您可以在 AWS Toolkit 中删除您拥有的自动化文档。删除自动化文档将删除该文档以及该文档的所有版本。

重要

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

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

  • 只有在您拥有文档的情况下才允许删除。

要删除您的自动化文档

  1. 在 AWS 资源管理器窗格中，对于 Systems Manager，展开 Own ed by Me 以列出您的文档。

  2. 打开要删除的文档的上下文（右键单击）菜单，然后选择 Delete document（删除文档）。

  3. 在显示的警告对话框中，选择 Delete（删除）以确认。

运行 Systems Manager 自动化文档

将自动化文档发布到后 AWS，您可以运行该文档以在中代表您执行任务 AWS 账户。要运行自动化文档，可以使用、Systems Manager APIs AWS CLI、或 AWS Tools for PowerShell。 AWS Management Console有关如何运行 Automation 文档的说明，请参阅 AWS Systems Manager 用户指南中的运行简单的自动化。

或者，如果您想在 Systems Manager 中使用其中一个APIs来运行自动化文档，请参阅AWS SDK参考资料。 AWS SDKs

重要

运行自动化文档可能会在中创建新资源， AWS 并可能产生账单费用。我们强烈建议您在运行自动化文档之前了解自动化文档将在账户中创建什么。