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

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

使用文档生成器创建运行手册

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

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

运行手册支持使用 Markdown(一种标记语言),它允许您为运行手册和运行手册内的单独步骤添加 Wiki 样式的描述。有关使用 Markdown 的更多信息,请参阅在 AWS 中使用 Markdown.

提示

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

开始前的准备工作

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

使用文档生成器创建运行手册

  1. 通过以下网址打开 AWS Systems Manager 控制台:https://console.amazonaws.cn/systems-manager/

  2. 在导航窗格中,选择文档

    -或者-

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

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

  4. 对于 Name,键入运行手册的描述性名称。

  5. 对于 Document description (文档描述),提供运行手册的 markdown 样式描述。您可以提供使用运行手册的说明、编号的步骤或描述运行手册的任何其他类型的信息。请参阅默认文本以了解设置内容格式的信息。

    提示

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

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

    重要

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

  7. (可选)对于 Outputs (输出),输入此运行手册的自动化的任何输出以供其他进程使用。

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

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

    1. 对于 Parameter name (参数名称),输入您要创建的运行手册参数的描述性名称。

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

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

      • 如果必须在运行时提供此运行手册参数的值,请选择 Yes (是)

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

    4. 对于 Description (描述),输入运行手册参数的描述。

    注意

    要添加更多运行手册参数,请选择 Add a parameter (添加参数)。要删除运行手册参数,请选择 X(删除)按钮。

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

    注意

    如果您指定值“/”,则运行手册可对所有类型的资源运行。有关有效资源类型的列表,请参阅 https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html 中的 AWS 资源类型参考AWS CloudFormation 用户指南。

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

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

    • 对于 Step name (步骤名称),输入自动化第一步的描述性名称。

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

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

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

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

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

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

      注意

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

    • (可选)对于 Outputs (输出),为此步骤输入任何输出,以使其他进程可用。

      注意

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

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

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

    注意

    要添加更多步骤,请选择 Add step (添加步骤),然后重复创建步骤的过程。要删除步骤,请选择 Remove step (删除步骤)

  12. 选择 Create automation (创建自动化) 以保存运行手册。