Systems Manager Automation 操作参考

name

在文档的所有步骤名称中必须唯一的标识符。

类型：字符串

必需：是

操作

步骤要运行的操作的名称。aws:runCommand 是可在此处指定的操作的示例。本文档提供有关所有可用操作的详细信息。

类型：字符串

必需：是

maxAttempts

在发生故障的情况下应重试步骤的次数。如果值大于 1，则直到所有重试尝试失败后，才会将此步骤视为失败。默认值是 1。

类型：整数

必需：否

timeoutSeconds

步骤的执行超时值。如果超时并且 maxAttempts 的值大于 1，则本步未考虑超时，直至已尝试所有重试。此字段没有默认值。

类型：整数

必需：否

onFailure

指示工作流程在失败时是应中止、继续还是转到其他步骤。该选项的默认值为“中止”。

类型：字符串

有效值：Abort | Continue | step:step_name

必需：否

isEnd

此选项在特定步骤结束时停止自动化执行。如果步骤执行失败，自动化执行将停止，否则将成功。默认值为 False。

类型：布尔值

有效值：true | false

必需：否

下面是如何在文档的 mainSteps 部分中输入此选项的示例：

JSON

"mainSteps":[
   {
      "name":"InstallMsiPackage",
      "action":"aws:runCommand",
      "onFailure":"step:PostFailure",
      "maxAttempts":2,
      "inputs":{
         "InstanceIds":[
            "i-1234567890EXAMPLE","i-abcdefghiEXAMPLE"
        ],
         "DocumentName":"AWS-RunPowerShellScript",
         "Parameters":{
            "commands":[
               "msiexec /i {{packageName}}"
            ]
         }
      },
      "nextStep":"TestPackage"
   },
   {
      "name":"TestPackage",
      "action":"aws:invokeLambdaFunction",
      "maxAttempts":1,
      "timeoutSeconds":500,
      "inputs":{
         "FunctionName":"TestLambdaFunction"
      },
      "isEnd":true
   }
]

YAML

mainSteps:
- name: InstallMsiPackage
  action: aws:runCommand
  onFailure: step:PostFailure
  maxAttempts: 2
  inputs:
    InstanceIds:
    - i-1234567890EXAMPLE
    - i-abcdefghiEXAMPLE
    DocumentName: AWS-RunPowerShellScript
    Parameters:
      commands:
      - msiexec /i {{packageName}}
  nextStep: TestPackage
- name: TestPackage
  action: aws:invokeLambdaFunction
  maxAttempts: 1
  timeoutSeconds: 500
  inputs:
    FunctionName: TestLambdaFunction
  isEnd: true

nextStep

指定在成功完成自动化工作流程中的一个步骤后，接下来处理哪个步骤。

下面是如何在文档的 mainSteps 部分中输入此选项的示例：

JSON

"mainSteps":[
    {
        "name":"InstallMsiPackage",
        "action":"aws:runCommand",
        "onFailure":"step:PostFailure",
        "maxAttempts":2,
        "inputs":{
            "InstanceIds":[
                "i-1234567890EXAMPLE","i-abcdefghiEXAMPLE"
            ],
            "DocumentName":"AWS-RunPowerShellScript",
            "Parameters":{
                "commands":[
                    "msiexec /i {{packageName}}"
                ]
            }
        },
        "nextStep":"TestPackage"
    }
]

YAML

mainSteps:
- name: InstallMsiPackage
  action: aws:runCommand
  onFailure: step:PostFailure
  maxAttempts: 2
  inputs:
    InstanceIds:
    - i-1234567890EXAMPLE
    - i-abcdefghiEXAMPLE
    DocumentName: AWS-RunPowerShellScript
    Parameters:
      commands:
      - msiexec /i {{packageName}}
  nextStep: TestPackage

isCritical

将一个步骤指定为成功完成自动化的关键步骤。如果具有此分派的步骤失败，则自动化会将自动化的最终状态报告为失败。该选项的默认值为 true。

类型：布尔值

有效值：true | false

必需：否

下面是如何在文档的 mainSteps 部分中输入此选项的示例：

JSON

"mainSteps":[
    {
       "name":"InstallMsiPackage",
       "action":"aws:runCommand",
       "onFailure":"step:SomeOtherStep",
       "isCritical":false,
       "maxAttempts":2,
       "inputs":{
          "InstanceIds":["i-1234567890EXAMPLE","i-abcdefghiEXAMPLE"],
          "DocumentName":"AWS-RunPowerShellScript",
          "Parameters":{
             "commands":[
                "msiexec /i {{packageName}}"
             ]
          }
       },
       "nextStep":"TestPackage"
    }
]

YAML

mainSteps:
- name: InstallMsiPackage
  action: aws:runCommand
  onFailure: step:SomeOtherStep
  isCritical: false
  maxAttempts: 2
  inputs:
    InstanceIds:
    - i-1234567890EXAMPLE,i-abcdefghiEXAMPLE
    DocumentName: AWS-RunPowerShellScript
    Parameters:
      commands:
      - msiexec /i {{packageName}}
  nextStep: TestPackage

inputs

特定于操作的属性。

类型：映射

必需：是

NotificationArn

Automation 批准的 Amazon SNS 主题的 ARN。当您在 Automation 文档中指定 aws:approve 步骤时，Automation 将向此主题发送消息，以让委托人知道必须批准或拒绝 Automation 步骤。Amazon SNS 主题的标题必须使用前缀“Automation”。

类型：字符串

必需：否

Message

发送批准请求时要包含在 SNS 主题中的信息。最大消息长度为 4096 个字符。

类型：字符串

必需：否

MinRequiredApprovals

恢复 Automation 执行所需的批准的最大数。如果您未指定值，系统将默认为 1。此参数的值必须为正数。此参数的值不能超过 Approvers 参数定义的审批者数。

类型：整数

必需：否

Approvers

能够批准或拒绝操作的经 AWS 身份验证的委托人的列表。最大审批者数为 10。您可使用以下任意格式指定委托人：

• AWS Identity and Access Management (IAM) 用户名称

• IAM 用户 ARN

• IAM 角色 ARN

• IAM 代入角色用户 ARN

类型：StringList

必需：是

ApprovalStatus

步骤的批准状态。状态可以为下列状态之一：已批准、已拒绝或正在等待。“正在等待”意味着 Automation 正在等待来自审批者的输入。

类型：字符串

ApproverDecisions

包括每位审批者的批准决定的 JSON 映射。

类型：MapList

服务

包含要运行的 API 操作的 AWS 服务命名空间。例如，Systems Manager 的命名空间为 ssm。Amazon EC2 的命名空间为 ec2。您可以查看 Amazon Web Services General Reference 中的 Amazon 资源名称 (ARN) 和 AWS 服务命名空间中的 AWS 服务命名空间列表。

类型：字符串

必需：是

API

要运行的 API 操作的名称。您可以在以下服务参考页面的左侧导航栏中选择服务来查看 API 操作（也称为方法）。在要调用的服务的 Client 部分中选择一种方法。例如，以下页面中列出了 Amazon Relational Database Service (Amazon RDS) 的所有 API 操作（方法）：Amazon RDS 方法。

类型：字符串

必需：是

API 操作输入

一个或多个 API 操作输入。您可以在以下服务参考页面的左侧导航栏中选择服务来查看可用的输入（也称为参数）。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法并向下滚动以查看可用的参数，例如 DBInstanceIdentifier、Name 和 Values。使用以下格式指定多个输入。

JSON

"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API action name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

YAML

inputs:
  Service: The official namespace of the service
  Api: The API action name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value

类型：由选择的 API 操作确定

必需：是

PropertySelector

响应对象中特定属性的 JSONPath。您可以在以下服务参考页面的左侧导航栏中选择服务来查看响应对象。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法，然后向下滚动到 Response Structure (响应结构) 部分。DBInstances 被列为响应对象。

类型：Integer、Boolean、String、StringList、StringMap 或 MapList

必需：是

DesiredValues

要继续 Automation 工作流程的预期状态。如果指定布尔值，则必须使用大写字母，例如 True 或 False。

类型：可变

必需：是

Choices

Automation 在确定下一个要处理的步骤时应评估的一个或多个表达式。通过使用布尔表达式对选择进行评估。每个选择都必须定义以下选项：

• NextStep：当指定的选择为真时，Automation 文档要处理的下一个步骤。

• Variable：指定在 Automation 文档的 Parameters 部分中定义的参数名称。或指定来自 Automation 文档中上一步的输出对象。有关为 aws:branch 创建变量的更多信息，请参阅关于创建输出变量。

• 运算：用于评估选择的标准。aws:branch 操作支持以下运算：

  字符串运算

  • 字符串等于

  • EqualsIgnoreCase

  • StartsWith

  • EndsWith

  • 包含

  数值运算

  • NumericEquals

  • NumericGreater

  • NumericLesser

  • NumericGreaterOrEquals

  • NumericLesser

  • NumericLesserOrEquals

  布尔运算

  • BooleanEquals

  重要

  创建 Automation 文档时，系统将验证文档中的每个操作。在尝试创建文档时，如果某个操作不受支持，系统会返回错误。

默认值

当所有 Choices 都为假时，工作流程应跳转到的步骤的名称。

类型：字符串

必需：否

InstanceIds

实例的 ID。

类型：StringList

必需：是

CheckStateOnly

如果为 false，请将实例状态设置为预期状态。如果为 true，请使用轮询断言预期状态。

类型：布尔值

必需：否

DesiredState

预期状态。设置为 running 时，此操作在完成之前等待 Amazon EC2 状态变为 Running、实例状态变为 OK、系统状态变为 OK。

类型：字符串

有效值：running | stopped | terminated

必需：是

Force

如果设置此项，则强制停止实例。则该实例没有机会来刷新文件系统缓存或文件系统元数据。如果您使用此选项，则必须执行文件系统检查和修复流程。我们不建议将该选项用于 Windows 实例。

类型：布尔值

必需：否

AdditionalInfo

预留。

类型：字符串

必需：否

SourceRegion

源 AMI 当前所在的区域。

类型：字符串

必需：是

SourceImageId

要从源区域复制的 AMI ID。

类型：字符串

必需：是

ImageName

新映像的名称。

类型：字符串

必需：是

ImageDescription

目标映像的描述。

类型：字符串

必需：否

加密

对目标 AMI 进行加密。

类型：布尔值

必需：否

KmsKeyId

在复制操作期间对映像快照进行加密时要使用的 AWS Key Management Service CMK 的完整 Amazon 资源名称 (ARN)。有关更多信息，请参阅 CopyImage。

类型：字符串

必需：否

ClientToken

您为确保请求幂等性而提供的唯一、区分大小写的标识符。有关更多信息，请参阅 CopyImage。

类型：字符串

必需：否

输出

ImageId

已复制映像的 ID。

ImageState

已复制映像的状态。

有效值：available | pending | failed

实例 ID

实例的 ID。

类型：字符串

必需：是

ImageName

映像的名称。

类型：字符串

必需：是

ImageDescription

映像的描述。

类型：字符串

必需：否

NoReboot

一种布尔文本。

默认情况下，Amazon EC2 会尝试关闭并重新启动实例，然后再创建映像。如果 No Reboot (不重启) 选项设置为 true，则 Amazon EC2 在创建映像前不会关闭实例。如果使用此选项，则无法保证所创建映像上的文件系统的完整性。

如果您希望在从实例创建 AMI 映像后，该实例不运行，请先使用 aws:changeInstanceState 插件停止实例，然后在 NoReboot 选项设置为 true 的情况下使用此 aws:createImage 插件。

类型：布尔值

必需：否

BlockDeviceMappings

适用于实例的块储存设备。

类型：映射

必需：否

输出

ImageId

新建映像的 ID。

ImageState

作为字符串文本值提供的执行脚本。如果输入文本值，则必须为 Base64 编码。

必需：否

功能

必须在 AWS CloudFormation 可以创建某些堆栈之前指定的值列表。一些堆栈模板中包含的资源会影响您的 AWS 账户中的权限。例如，创建新 AWS Identity and Access Management (IAM) 用户会影响您账户中的权限。对于这些堆栈，您必须通过指定此参数来明确确认它们的功能。

有效值仅为 CAPABILITY_IAM 和 CAPABILITY_NAMED_IAM。以下资源要求您指定此参数。

• AWS::IAM::AccessKey

• AWS::IAM::Group

• AWS::IAM::InstanceProfile

• AWS::IAM::Policy

• AWS::IAM::Role

• AWS::IAM::User

• AWS::IAM::UserToGroupAddition

如果您的堆栈模板包含这些资源，我们建议您查看与之关联的所有权限并在必要时编辑其权限。

如果包含 IAM 资源，您可以指定任意一个功能。如果包含具有自定义名称的 IAM 资源，则必须指定 CAPABILITY_NAMED_IAM。如果您不指定此参数，则此操作会返回 InsufficientCapabilities 错误。

有关更多信息，请参阅确认 AWS CloudFormation 模板中的 IAM 资源。

类型：字符串的数组

有效值：CAPABILITY_IAM | CAPABILITY_NAMED_IAM

必需：否

ClientRequestToken

该 CreateStack 请求的唯一标识符。如果将此步骤中的 maxAttempts 设置为大于 1 的值，请指定此令牌。通过指定此令牌，AWS CloudFormation 知道您未在尝试使用相同的名称创建新堆栈。

类型：字符串

必需：否

长度约束：最小长度为 1。长度上限为 128。

模式：[a-zA-Z0-9][-a-zA-Z0-9]*

DisableRollback

如果堆栈创建失败，请设置为 true 以禁用堆栈回滚。

Conditional：您可以指定 DisableRollback 参数或 OnFailure 参数，但不能同时指定。

默认值：false

类型：布尔值

必需：否

NotificationARNs

用于发布堆栈相关事件的 Amazon SNS 主题 ARN。您可以使用 Amazon SNS 控制台 (https://console.amazonaws.cn/sns/v2/home) 找到 SNS 主题 ARN。

类型：字符串的数组

数组成员：最多 5 项。

必需：否

OnFailure

如果堆栈创建失败，确定要执行的操作。您必须指定 DO_NOTHING、ROLLBACK 或 DELETE。

Conditional：您可以指定 OnFailure 参数或 DisableRollback 参数，但不能同时指定。

默认值：ROLLBACK

类型：字符串

有效值： DO_NOTHING | ROLLBACK | DELETE

必需：否

参数

指定堆栈输入参数的 Parameter 结构列表。有关更多信息，请参阅参数数据类型。

类型：参数对象数组

必需：否

ResourceTypes

您有权用于此创建堆栈操作的模板资源类型。例如，AWS::EC2::Instance、AWS::EC2::* 或 Custom::MyCustomInstance。使用以下语法描述模板资源类型。

• 对于所有 AWS 资源：

  AWS::*

• 对于所有自定义资源：

  Custom::*

• 对于指定自定义资源：

  Custom::logical_ID

• 对于特定 AWS 服务的所有资源：

  AWS::service_name::*

• 对于特定的 AWS 资源：

  AWS::service_name::resource_logical_ID

如果资源类型列表不包括您创建的资源，那么堆栈创建将会失败。默认情况下，AWS CloudFormation 对所有资源类型授予权限。IAM 将此参数用于 IAM 策略中 AWS CloudFormation 特定的条件键。有关更多信息，请参阅使用 AWS Identity and Access Management 控制访问权限。

类型：字符串的数组

长度约束：最小长度为 1。长度上限为 256。

必需：否

RoleARN

AWS CloudFormation 创建堆栈所代入的 IAM 角色的 Amazon 资源名称 (ARN)。AWS CloudFormation 使用该角色的凭证以您的名义进行调用。AWS CloudFormation 针对堆栈的所有未来操作始终使用此角色。只要用户有权对堆栈进行操作，AWS CloudFormation 会使用此角色，即使用户无权传递它。确保该角色授予最少的权限。

如果您不指定值，则 AWS CloudFormation 会使用之前与堆栈关联的角色。如果角色不可用，则 AWS CloudFormation 会使用您的用户凭证生成的一个临时会话。

类型：字符串

长度约束：最小长度为 20。长度上限为 2048。

必需：否

StackName

与堆栈关联的名称。名称在您创建堆栈的区域中必须是唯一的。

注意

堆栈名称只能包含字母数字字符（区分大小写）和连字符。该名称必须以字母字符开头，且不得超过 128 个字符。

类型：字符串

必需：是

StackPolicyBody

包含堆栈策略正文的结构。有关更多信息，请参阅防止更新堆栈资源。

Conditional：您可以指定 StackPolicyBody 参数或 StackPolicyURL 参数，但不能同时指定。

类型：字符串

长度约束：最小长度为 1。长度上限为 16384。

必需：否

StackPolicyURL

包含堆栈策略的文件的位置。URL 指向的策略必须位于与堆栈处于同一区域的 Amazon S3 存储桶中。堆栈策略允许的最大文件大小为 16 KB。

Conditional：您可以指定 StackPolicyBody 参数或 StackPolicyURL 参数，但不能同时指定。

类型：字符串

长度约束：最小长度为 1。长度上限为 1350。

必需：否

Tags

与此堆栈关联的键值对。AWS CloudFormation 还可以将这些标签传播到堆栈中创建的资源。您可以指定最多 10 个标签。

类型：标签对象数组

必需：否

TemplateBody

包含最小长度为 1 字节、最大长度为 51200 字节的模板正文的结构。有关更多信息，请参阅模板剖析。

Conditional：您可以指定 TemplateBody 参数或 TemplateURL 参数，但不能同时指定。

类型：字符串

长度约束：最小长度为 1。

必需：否

TemplateURL

包含模板正文的文件的位置。URL 必须指向一个位于 Amazon S3 存储桶中的模板。模板允许的最大大小为 460800 字节。有关更多信息，请参阅模板剖析。

Conditional：您可以指定 TemplateBody 参数或 TemplateURL 参数，但不能同时指定。

类型：字符串

长度约束：最小长度为 1。长度上限为 1024。

必需：否

TimeoutInMinutes

堆栈状态变为 CREATE_FAILED 前允许经过的时间。如果未设置 DisableRollback 或将其设置为 false，堆栈将被回滚。

类型：整数

有效范围：最小值为 1。

必需：否

堆栈 ID

堆栈的唯一标识符。

类型：字符串

StackStatus

堆栈的当前状态。

类型：字符串

有效值：CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | REVIEW_IN_PROGRESS

必需：是

StackStatusReason

与堆栈状态相关联的成功或失败消息。

类型：字符串

必需：否

有关更多信息，请参阅 CreateStack。

ResourceIds

要为其添加标签的资源的 ID。如果资源类型不是“EC2”，则此字段只能包含单个项目。

类型：字符串列表

必需：是

Tags

要与资源关联的标签。

类型：映射列表

必需：是

ResourceType

要为其添加标签的资源的类型。如果未提供，则使用默认值“EC2”。

类型：字符串

必需：否

有效值: EC2 | ManagedInstance | MaintenanceWindow | Parameter

ImageId

要删除的映像的 ID。

类型：字符串

必需：是

ClientRequestToken

此 DeleteStack 请求的唯一标识符。如果您计划重试请求以便 AWS CloudFormation 知道您未在尝试删除同名堆栈，请指定此令牌。您可以重试 DeleteStack 请求以验证 AWS CloudFormation 是否收到了它们。

类型：字符串

长度约束：最小长度为 1。长度上限为 128。

模式：[a-zA-Z][-a-zA-Z0-9]*

必需：否

RetainResources.member.N

此输入仅适用于处于 DELETE_FAILED 状态的堆栈。您想要保留的资源的逻辑资源 ID 的列表。在删除时，AWS CloudFormation 删除堆栈，但不删除保留资源。

如果无法删除某个资源 (例如非空 Amazon S3 存储桶)，但需要删除堆栈，则保留资源会很有用。

类型：字符串的数组

必需：否

RoleARN

AWS CloudFormation 创建堆栈所代入的 IAM 角色的 Amazon 资源名称 (ARN)。AWS CloudFormation 使用该角色的凭证以您的名义进行调用。AWS CloudFormation 针对堆栈的所有未来操作始终使用此角色。只要用户有权对堆栈进行操作，AWS CloudFormation 会使用此角色，即使用户无权传递它。确保该角色授予最少的权限。

如果您不指定值，则 AWS CloudFormation 会使用之前与堆栈关联的角色。如果角色不可用，则 AWS CloudFormation 会使用您的用户凭证生成的一个临时会话。

类型：字符串

长度约束：最小长度为 20。长度上限为 2048。

必需：否

StackName

与堆栈关联的名称或唯一堆栈 ID。

类型：字符串

必需：是

DocumentName

要在步骤中运行的辅助自动化文档的名称。该文档必须属于与主要自动化文档相同的 AWS 账户。

类型：字符串

必需：是

DocumentVersion

要在步骤中运行的辅助自动化文档的版本。如果未指定，自动化将运行默认文档版本。

类型：字符串

必需：是

RuntimeParameters

辅助文档执行所需的参数。映射使用以下格式：{"parameter1" : ["value1"], "parameter2" : ["value2"] }

类型：映射

必需：否

输出

输出

辅助执行生成的输出。您可以使用以下格式引用输出：Secondary_Automation_Step_Name.Output

类型：StringList

ExecutionId

辅助执行的执行 ID。

类型：字符串

Status

辅助执行的状态。

类型：字符串

服务

包含要运行的 API 操作的 AWS 服务命名空间。例如，Systems Manager 的命名空间为 ssm。Amazon EC2 的命名空间为 ec2。您可以查看 Amazon Web Services General Reference 中的 Amazon 资源名称 (ARN) 和 AWS 服务命名空间的 AWS 服务命名空间列表。

类型：字符串

必需：是

API

要运行的 API 操作的名称。您可以在以下服务参考页面的左侧导航栏中选择服务来查看 API 操作（也称为方法）。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有 API 操作（方法）。

类型：字符串

必需：是

API 操作输入

一个或多个 API 操作输入。您可以在以下服务参考页面的左侧导航栏中选择服务来查看可用的输入（也称为参数）。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法并向下滚动以查看可用的参数，例如 DBInstanceIdentifier、Name 和 Values。

JSON

"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API action name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

YAML

inputs:
  Service: The official namespace of the service
  Api: The API action name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value

类型：由选择的 API 操作确定

必需：是

名称

输出的名称。

类型：字符串

必需：是

Selector

响应对象中特定属性的 JSONPath。您可以在以下服务参考页面的左侧导航栏中选择服务来查看响应对象。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法，然后向下滚动到 Response Structure (响应结构) 部分。DBInstances 被列为响应对象。

类型：Integer、Boolean、String、StringList、StringMap 或 MapList

必需：是

Type

响应元素的数据类型。

类型：可变

必需：是

stateMachineArn

Step Functions 状态机的 ARN。

类型：字符串

必需：是

name

执行的名称。

类型：字符串

必需：否

input

包含执行的 JSON 输入数据的字符串。

类型：字符串

必需：否

FunctionName

Lambda 函数的名称。此函数必须存在。

类型：字符串

必需：是

限定词

函数版本或别名。

类型：字符串

必需：否

InvocationType

调用类型。默认为 RequestResponse。

类型：字符串

有效值：Event | RequestResponse | DryRun

必需：否

LogType

如果是 Tail，调用类型必须为 RequestResponse。AWS Lambda 返回 Lambda 函数生成的采用 base64 编码的最后 4 KB 日志数据。

类型：字符串

有效值：None | Tail

必需：否

ClientContext

特定于客户端的信息。

必需：否

Payload

您的 Lambda 函数的 JSON 输入。

必需：否

输出

StatusCode

函数执行状态代码。

FunctionError

指示运行 Lambda 函数时是否出现错误。如果出现错误，则此字段将显示 Handled 或 Unhandled。Handled 错误由函数报告。Unhandled 错误由 AWS Lambda 检测和报告。

LogResult

Lambda 函数调用的 base64 编码日志。只有在调用类型为 RequestResponse 并且请求了日志时，才存在日志。

Payload

Lambda 函数返回的对象的 JSON 表示形式。只有在调用类型为 RequestResponse 时才存在有效负载。

输出

无

DocumentName

Run Command 文档的名称。

类型：字符串

必需：是

InstanceIds

要在其中运行命令的实例 ID。您可以指定最多 50 个 ID。如果不想指定每个实例 ID，可以使用 Targets 参数将命令发送到一组实例。Targets 参数接受 Amazon EC2 标签。有关如何使用 Targets 参数的更多信息，请参阅使用目标和速率控制将命令发送到队列。

类型：StringList

必需：否（如果未指定 InstanceIds，则必须指定 Targets 参数。）

目标

一组搜索条件，使用您指定的 Key、Value 组合来设置实例目标。如果未在调用中提供一个或多个实例 ID，则 Targets 是必需的。有关如何使用 Targets 参数的更多信息，请参阅使用目标和速率控制将命令发送到队列。

类型：MapList（列表中 map 的架构必须与对象匹配。有关信息，请参阅 AWS Systems Manager API Reference 中的 Target。）

必需：否（如果未指定 Targets，则必须指定 InstanceIds 参数。）

示例如下：

{
    "name": "installPowerShellModule",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-InstallPowerShellModule",
        "Targets": [                   
            {
                "Key": "tag:Stage",
                "Values": [
                    "Gamma", "Beta"
                ]
            },
            {
                "Key": "tag-key",
                "Values": [
                    "Suite"
                ]
            }
        ]
        "Parameters": {
            "source": "https://my-s3-url.com/MyModule.zip ",
            "sourceHash": "ASDFWER12321WRW"
        }
    }
}

Parameters

文档中指定的必需参数和可选参数。

类型：映射

必需：否

CloudWatchOutputConfig

用于将命令输出发送到 Amazon CloudWatch Logs 的配置选项。有关将命令输出发送到 CloudWatch Logs 的更多信息，请参阅为 Run Command 配置 Amazon CloudWatch Logs。

类型：StringMap（map 的架构必须与对象匹配。有关更多信息，请参阅 AWS Systems Manager API Reference 中的 CloudWatchOutputConfig。）

必需：否

示例如下：

{
    "name": "installPowerShellModule",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-InstallPowerShellModule",
        "InstanceIds": ["i-1234567890abcdef0"],
        "Parameters": {
            "source": "https://my-s3-url.com/MyModule.zip ",
            "sourceHash": "ASDFWER12321WRW"
        },
        "CloudWatchOutputConfig" : { 
            "CloudWatchLogGroupName": "CloudWatchGroupForSSMAutomationService",
            "CloudWatchOutputEnabled": true
        }
    }
}

Comment

有关此命令的用户定义的信息。

类型：字符串

必需：否

DocumentHash

文档的哈希。

类型：字符串

必需：否

DocumentHashType

哈希的类型。

类型：字符串

有效值：Sha256 | Sha1

必需：否

NotificationConfig

用于发送通知的配置。

必需：否

OutputS3BucketName

命令执行响应的 S3 存储桶的名称。

类型：字符串

必需：否

OutputS3KeyPrefix

前缀。

类型：字符串

必需：否

ServiceRoleArn

IAM 角色的 ARN。

类型：字符串

必需：否

TimeoutSeconds

run-command 超时值 (以秒为单位)。

类型：整数

必需：否

输出

CommandId

命令的 ID。

Status

命令的状态。

ResponseCode

命令的响应代码。

输出

命令的输出。

ImageId

Amazon 系统映像 (AMI) 的 ID。

类型：字符串

必需：是

InstanceType

实例的类型。

类型：字符串

必需：否

MinInstanceCount

要启动的实例的最小数量。

类型：字符串

必需：否

MaxInstanceCount

要启动的实例的最大数量。

类型：字符串

必需：否

AdditionalInfo

预留。

类型：字符串

必需：否

BlockDeviceMappings

适用于实例的块储存设备。

类型：MapList

必需：否

ClientToken

用于确保请求的幂等性的标识符。

类型：字符串

必需：否

DisableApiTermination

启用或禁用实例 API 终止

类型：布尔值

必需：否

EbsOptimized

启用或禁用 EBS 优化。

类型：布尔值

必需：否

IamInstanceProfileArn

实例的 IAM 实例配置文件的 ARN。

类型：字符串

必需：否

IamInstanceProfileName

实例的 IAM 实例配置文件的名称。

类型：字符串

必需：否

InstanceInitiatedShutdownBehavior

指示此实例是否在系统关闭时停止或终止。

类型：字符串

必需：否

KernelId

内核的 ID。

类型：字符串

必需：否

KeyName

密钥对的名称。

类型：字符串

必需：否

MaxInstanceCount

搜索服务时可筛选的实例数量上限。

类型：整数

必需：否

MinInstanceCount

搜索服务时可筛选的实例数量下限。

类型：整数

必需：否

监控

启动或禁用详细监控。

类型：布尔值

必需：否

NetworkInterfaces

网络接口。

类型：MapList

必需：否

Placement

实例的置放。

类型：StringMap

必需：否

PrivateIpAddress

主要 IPv4 地址。

类型：字符串

必需：否

RamdiskId

RAM 磁盘的 ID。

类型：字符串

必需：否

SecurityGroupIds

实例的安全组的 ID。

类型：StringList

必需：否

SecurityGroups

实例的安全组的名称。

类型：StringList

必需：否

SubnetId

子网 ID。

类型：字符串

必需：否

TagSpecifications

在启动期间应用于资源的标签。您只能在启动时标记实例和卷。指定的标签将应用于在启动期间创建的所有实例或卷。要在启动实例后对其进行标记，请使用 aws:createTags 操作。

类型：MapList（有关更多信息，请参阅 TagSpecification。）

必需：否

UserData

作为字符串文本值提供的执行脚本。如果输入文本值，则必须为 Base64 编码。

类型：字符串

必需：否

输出

InstanceIds

实例的 ID。

Duration

ISO 8601 持续时间。您不能指定负数持续时间。

类型：字符串

必需：否

时间戳

ISO 8601 时间戳。如果您没有为此参数指定值，那么必须为 Duration 参数指定一个值。

类型：字符串

必需：否

输出

无

服务

包含要运行的 API 操作的 AWS 服务命名空间。例如，Systems Manager 的命名空间为 ssm。Amazon EC2 的命名空间为 ec2。您可以查看 Amazon Web Services General Reference 中的 Amazon 资源名称 (ARN) 和 AWS 服务命名空间中的 AWS 服务命名空间列表。

类型：字符串

必需：是

API

要运行的 API 操作的名称。您可以在以下服务参考页面的左侧导航栏中选择服务来查看 API 操作（也称为方法）。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有 API 操作（方法）。

类型：字符串

必需：是

API 操作输入

一个或多个 API 操作输入。您可以在以下服务参考页面的左侧导航栏中选择服务来查看可用的输入（也称为参数）。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法并向下滚动以查看可用的参数，例如 DBInstanceIdentifier、Name 和 Values。

JSON

"inputs":{
      "Service":"The official namespace of the service",
      "Api":"The API action name",
      "API input 1":"A value",
      "API Input 2":"A value",
      "API Input 3":"A value"
}

YAML

inputs:
  Service: The official namespace of the service
  Api: The API action name
  API input 1: A value
  API Input 2: A value
  API Input 3: A value

类型：由选择的 API 操作确定

必需：是

PropertySelector

响应对象中特定属性的 JSONPath。您可以在以下服务参考页面的左侧导航栏中选择服务来查看响应对象。在要调用的服务的 Client 部分中选择一种方法。例如，Amazon RDS 方法页面中列出了 Amazon RDS 的所有方法。选择 describe_db_instances 方法，然后向下滚动到 Response Structure (响应结构) 部分。DBInstances 被列为响应对象。

类型：Integer、Boolean、String、StringList、StringMap 或 MapList

必需：是

DesiredValues

要继续 Automation 工作流程的预期状态。

类型：可变

必需：是