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

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

如果 Amazon Systems Manager 公有运行手册不支持您希望在 Amazon 资源上执行的操作,您可以创建自己的运行手册。要创建自定义运行手册,您可以手动创建包含相应自动化操作的本地 YAML 或 JSON 格式文件。或者,您也可以使用 Systems Manager 控制台中的文档生成器来构建自定义运行手册。

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

自动化文档支持使用 Markdown(一种标记语言),它允许您为运行手册和其中的各个步骤添加 Wiki 样式的描述。有关使用 Markdown 的更多信息,请参阅在 Amazon 中使用 Markdown

提示

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

开始前的准备工作

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

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

  1. 访问 https://console.aws.amazon.com/systems-manager/,打开 Amazon Systems Manager 控制台。

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

    -或者-

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

  3. 选择创建自动化

  4. 对于名称,为运行手册输入一个描述性名称。

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

    提示

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

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

    重要

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

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

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

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

    1. 对于参数名称,请输入要创建的运行手册参数的描述性名称。

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

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

      • 如果必须在运行时提供该运行手册参数的值,请选择

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

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

    注意

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

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

    注意

    如果指定“/”值,则可以在所有类型的资源上运行此运行手册。有关有效资源类型列表,请参阅 Amazon CloudFormation 用户指南 中的 Amazon 资源类型参考

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

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

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

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

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

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

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

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

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

      注意

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

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

      注意

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

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

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

    注意

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

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