使用 Systems Manager 自动化文件 - AWSToolkit for VS Code

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

使用 Systems Manager 自动化文件

AWS Systems Manager 让您能够查看和控制 AWS 上的基础设施。Systems Manager 可以提供一个统一的用户界面,供您查看多种 AWS 服务的运行数据,并在 AWS 资源上自动执行操作任务。

Systems Manager 文档定义 Systems Manager 对您的托管式实例执行的操作。自动化文档是一种 Systems Manager 文档,用于执行常见的维护和部署任务,如创建或更新 Amazon Machine 映像 (AMI)。本主题概述了如何通过 Automation 创建、编辑、发布和删除 Automation 文档AWS Toolkit for Visual Studio Code.

假设和先决条件

在您开始之前,请确保:

Systems Manager 自动化文档的 IAM 权限

在Toolkit for VS Code 中,您必须有一个凭据配置文件,其中包含AWS Identity and Access Management(IAM) 权限是创建、编辑、发布和删除 Systems Manager Automation 文档所必需的。以下策略文档定义了可在委托人策略中使用的必要 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证书.

创建新 Systems Manager 自动化文档

您可以在中创建新的 “自动化” 文档JSON要么YAML使用 Visual Studio 代码 当您新建自动化文档时,它将显示在无标题文件中。您可以命名并将其保存在 VS Code 中,但是文件的名称对于AWS.

要新建自动化文档

  1. 打开 VS Code。

  2. 在存储库的查看菜单中,选择命令调色板以打开命令调色板。

  3. 在命令调色板中,输入AWS工具包本地创建新的 Systems Manager 文档.

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

  5. 选择 JSONYAML

    将创建一个新的自动化文档。

注意

你在 VS Code 中的新 Automation 文档不会自动出现在AWS. 您必须将其发布至 AWS 后方可运行。

打开现有 Systems Manager 自动化文

你将AWSExplorer 以查找现有 Systems Manager 当您打开现有 Automation 文档时,它将显示为 VS Code 中的无标题文件。

打开 “自动化” 文档

  1. 打开 VS Code。

  2. 从左侧导航中,选择AWS以打开AWSExporer

  3. 在AWSExplorerSystems Manager,请在要打开的文档上选择下载图标,然后选择文档版本。文件将以该版本的格式打开。否则,请选择其中一个以 JSON 格式下载要么作为 YAML 下载.

注意

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

编辑 Systems Manager 自动化文

如果您拥有任何 Automation 文档,它们将显示在归我所有类别中的Systems Manager 文档AWSExporer 您可以拥有 Automation 中已存在的文档AWS,并且您可以拥有之前发布到的新的或更新的文档AWS来自 VS Code。

当你在 VS Code 中打开 Automation 文档进行编辑时,你可以用它做比在AWS Management Console. 例如:

  • 两者都有模式验证JSONYAML格式。

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

  • 中的各种选项都有自动完成支持JSONYAML.

使用版本

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

要设置默认版本

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

    注意

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

发布 Systems Manager 自动化文

在 VS Code 中编辑 Automation 文档后,您可以将其发布到AWS.

要发布 Automation 文档

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

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

  3. 在打开的文件的右上角,选择 Upload (上载) 图标。

  4. 在发布工作流程对话框中,选择AWS您想要将 Automation 文档发布到的区域。

  5. 如果您要发布新文档,请选择快速创建. 否则,请选择快速更新更新其中现有的 Automation 文档AWS区域。

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

将现有 Automation 文档的更新发布到AWS,则将向文档中添加一个新版本。

删除 Systems Manager 自动化文

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

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

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

要删除 Automation 文档

  1. 打开 VS Code。

  2. 从左侧导航中,选择AWS以打开AWSExporer

  3. 在AWSExplorerSystems Manager,请打开要删除的文档的上下文(右键单击)菜单,然后选择删除文档.

执行 Systems Manager 自动化文

一旦您的自动化文档发布到AWS,您可以将其运行以在AWSaccount. 要运行自动化文档,请使用 AWS Management Console、Systems Manager API、AWS CLI 或者 AWS Tools for PowerShell。有关运行自动化文档的说明,请参阅运行简单的自动化中的AWS Systems Manager用户指南.

或者,如果您希望使用其中一个带有 Systems Manager API 的 AWS SDK 来运行您的自动化文档,请参阅 AWS SDK 参考

注意

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