使用运行手册 - Amazon Systems Manager
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

使用运行手册

注意

自动化文档现在称为运行手册。

自动化运行手册定义了自动化运行时 Systems Manager 在托管实例和其他 Amazon 资源上执行的操作。自动化是 Amazon Systems Manager 的一项功能。运行手册包含一个或多个按顺序运行的步骤。每个步骤是根据单个操作生成的。可以将一个步骤的输出作为后面步骤的输入。

运行这些操作及其步骤的过程称为自动化

让您可以在 Amazon 环境中自动完成各种不同操作的运行手册支持的操作类型。例如,通过使用 executeScript 操作类型,您可以直接在运行手册中嵌入 Python 或 PowerShell 脚本。(在创建自定义运行手册时,您可以按内联方式添加脚本,或者从 S3 存储桶或本地计算机中附加脚本。) 您可以使用 createStackdeleteStack 操作类型自动管理 Amazon CloudFormation 资源。此外,通过使用 executeAwsApi 操作类型,步骤可以在任意 Amazon Web Service中运行任意 API 操作,包括创建或删除 Amazon 资源、启动其他进程、触发通知等。

有关自动化支持的所有 20 种操作类型的列表,请参阅 Systems Manager 自动化操作参考

Amazon Systems Manager 自动化提供了几个包含预定义步骤的文档,您可以使用这些步骤执行常见任务,例如重新启动一个或多个 Amazon Elastic Compute Cloud (Amazon EC2) 实例或创建 Amazon Machine Image (AMI)。您还可以创建自己的运行手册并与其他 Amazon Web Services 账户 共享,或者向所有自动化用户公开。

运行手册是使用 YAML 或 JSON 编写的。但是,通过使用 Systems Manager 自动化中的文档生成器,您可以创建运行手册,而无需使用本机 JSON 或 YAML 创作。

重要

如果您运行使用 Amazon Identity and Access Management (IAM) 服务角色调用其他服务的自动化工作流程,请注意必须使用权限将该服务角色配置为调用这些服务。该要求适用于所有 Amazon 自动化运行手册(AWS-* 运行手册),例如 AWS-ConfigureS3BucketLoggingAWS-CreateDynamoDBBackupAWS-RestartEC2Instance 运行手册等。对于您创建的任何自定义自动化运行手册,如果这些文档使用调用其他服务的操作来调用其他 Amazon Web Services,则此要求同样适用。例如,如果您使用 aws:executeAwsApiaws:createStackaws:copyImage 操作,则您必须配置具有权限的服务角色来调用这些服务。您可以将 IAM 内联策略添加到该角色,从而向其他 Amazon Web Services授予权限。有关更多信息,请参阅(可选)添加自动化内联策略来调用其他 Amazon Web Services

有关可在运行手册中指定的操作的信息,请参阅 Systems Manager 自动化操作参考

有关运行脚本的 Amazon 托管运行手册,请参阅 运行脚本的 Amazon 托管运行手册

有关使用 Amazon Toolkit for Visual Studio Code 创建运行手册的信息,请参阅 《Amazon Toolkit for Visual Studio Code 用户指南》 中的 使用 Systems Manager 自动化文档

有关使用文档生成器创建自定义运行手册的信息,请参阅 使用文档生成器创建运行手册

有关创建运行脚本的自定义运行手册的信息,请参阅以下主题: