使用文档生成器创建 Automation 文档

使用文档生成器创建 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 操作的 Automation 文档，必须指定一个角色。有关信息，请参阅 运行 Automation 执行的权限。

7. （可选）对于 Outputs (输出)，请输入执行该文档的任何输出以供其他进程使用。

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

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

   1. 对于 Parameter name (参数名称)，请输入要创建的文档参数的描述性名称。

   2. 对于 Type (类型)，请选择参数的类型，例如 String 或 MapList。

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

      • 如果必须在运行时提供该文档参数的值，请选择 Yes (是)。

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

   4. 对于 Description (描述)，请输入文档参数的描述。

   注意

   要添加更多文档参数，请选择 Add a parameter (添加参数)。要删除文档参数，请选择 X（删除）按钮。

9. （可选）展开 Target type (目标类型) 部分，然后选择一种目标类型以定义可以运行文档的资源的类型。例如，要在 EC2 实例上运行文档，请选择 /AWS::EC2::Instance。

   注意

   如果指定“/”值，则可以对所有类型的资源运行文档。有关有效的资源类型的列表，请参阅 AWS CloudFormation User Guide 中的 AWS 资源类型参考。

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 (通用属性) 部分，然后指定所有 Automation 操作的通用操作属性。例如，对于 Timeout seconds (超时秒数)，您可以提供一个值以指定步骤在停止之前可以运行多长时间（以秒为单位）。

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

    注意

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

12. 选择 Create automation (创建自动化) 以保存文档。