使用文档生成器创建 Runbook - Amazon Web Services Systems Manager
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

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

使用文档生成器创建 Runbook

如果Amazon Web Services Systems Manager公有 Runbook 不支持要在Amazon资源,您可以创建自己的 Runbook。要创建自定义运行手册,您可以手动创建包含相应自动化操作的本地 JavaScript 对象表示法 (JSON) 或 YAML 格式文件。或者,您也可以使用 Systems Manager 控制台中的文档生成器更轻松地生成自定义 Runbook。

使用文档生成器,您可以将 Automation 操作添加到自定义 Runbook 中,并提供所需的参数,而无需使用 JSON 或 YAML 语法。添加步骤并创建 Runbook 后,系统将您添加的操作转换为 YAML 格式,Systems Manager 可用于运行自动化。

Runbook 支持使用 Markdown(一种标记语言),它允许您为运行手册和运行手册中的各个步骤添加维基风格的描述。有关如何使用降价的更多信息,请参阅。在 中使用 MarkdownAmazon

提示

本主题提供了将文档生成器用于任何支持的操作类型的一般信息。有关创建运行脚本的 Runbook 的更多信息,请参阅以下主题:

开始前的准备工作

在使用文档生成器创建自定义 Runbook 之前,我们建议您了解可在 Runbook 中使用的各种操作。有关更多信息,请参阅 Systems Manager Automation 操作参考

使用文档生成器创建 Runbook

  1. 打开Amazon Web Services Systems Manager控制台https://console.aws.amazon.com/systems-manager/

  2. 在导航窗格中,选择 Documents

    -或者-

    如果Amazon Web Services Systems Manager首先打开主页,选择菜单图标( ) 以打开导航窗格中的,然后选择。文档在导航窗格中。

  3. 选择 Create automation (创建自动化)

  4. 适用于名称中,输入 Runbook 的描述性名称。

  5. 适用于文档说明,请提供 Runbook 的降价样式描述。您可以提供使用 Runbook 的说明、编号的步骤或描述 Runbook 的任何其他类型的信息。请参阅默认文本以了解设置内容格式的信息。

    提示

    Hide preview (隐藏预览)Show preview (显示预览) 之间切换,以便在编写时查看描述内容的效果。

  6. (可选)对于 Assume role (担任角色),请输入代表您执行操作的服务角色的名称或 ARN。如果您不指定角色,则 Automation 使用运行自动化的用户的访问权限。

    重要

    对于不归 Amazon 所有并使用aws:executeScript操作,必须指定一个角色。有关信息,请参阅 使用运行手册的权限

  7. (可选)输出中,输入此 Runbook 的自动化输出以供其他进程使用。

    例如,如果您的 Runbook 创建新的 AMI,您可以指定 ["CreateImage.ImageId"],然后使用该输出以在后续自动化中创建新的实例。

  8. (可选)展开 Input parameters (输入参数) 部分,然后执行以下操作。

    1. 适用于参数名称中,输入要创建的 Runbook 参数的描述性名称。

    2. 对于 Type (类型),请选择参数的类型,例如 StringMapList

    3. 对于 Required (必需),请执行以下操作之一:

      • 选择(如果必须在运行时提供该 Runbook 参数的值)。

      • 如果该参数不是必需的,请选择 No (否),然后(可选)在 Default value (默认值) 中输入默认参数值。

    4. 适用于说明中,输入 Runbook 参数的描述。

    注意

    要添加更多 Runbook 参数,请选择添加参数。要删除运行簿参数,请选择X(删除) 按钮。

  9. (可选) 展开Target type部分,然后选择一种目标类型以定义可以运行自动化的资源的类型。例如,要在 EC2 实例上使用 Runbook,请选择/AWS::EC2::Instance

    注意

    如果您指定一个值为 '/',则 Runbook 可以在所有类型的资源上运行。有关有效资源类型的列表,请参阅Amazon资源类型参考中的Amazon CloudFormation用户指南

  10. (可选) 展开文档标签部分,然后输入一个或多个标签键/值对以应用于 Runbook。标签可以轻松标识、划分和搜索资源。有关更多信息,请参阅 标记 Systems Manager 文档

  11. Step 1 (步骤 1) 部分中,提供以下信息。

    • 适用于步骤名称中,输入自动化的第一步的描述性名称。

    • 对于 Action type (操作类型),请选择用于该步骤的操作类型。

      有关可用操作类型的列表和信息,请参阅 Systems Manager Automation 操作参考

    • 对于 Description (描述),请输入自动化步骤的描述。您可以使用 Markdown 设置文本格式。

    • 根据选定的 Action type (操作类型),在 Step inputs (步骤输入) 部分中输入操作类型所需的输入。例如,如果选择了 aws:approve 操作,您必须为 Approvers 属性指定一个值。

      有关步骤输入字段的信息,请参阅 Systems Manager Automation 操作参考中的选定操作类型的条目。例如:aws:executeStateMachine— 运行Amazon Step Functions状态机

    • (可选)其他投入,提供 Runbook 所需的任何其他输入值。可用的输入类型取决于您为步骤选择的操作类型。(请注意,某些操作类型需要使用输入值。)

      注意

      要添加更多输入,请选择 Add optional input (添加可选的输入)。要删除输入,请选择 X(删除)按钮。

    • (可选)输出中,输入该步骤的任何输出以供其他进程使用。

      注意

      Outputs (输出) 并非适用于所有操作类型。

    • (可选) 展开常见属性部分,然后指定所有自动化操作通用的操作属性。例如,对于 Timeout seconds (超时秒数),您可以提供一个值以指定步骤在停止之前可以运行多长时间(以秒为单位)。

      有关更多信息,请参阅 所有操作共享的属性

    注意

    要添加更多步骤,请选择添加步骤,然后重复创建步骤的过程。要移除步骤,请选择删除步骤

  12. 选择创建自动化以保存运行簿。