Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

工作流程文档支持的步骤操作

本节详细介绍了 Image Builder 支持的步骤操作。

ApplyImageConfigurations

此步骤操作将各种配置和集成应用于分布式 AMIs，例如许可证配置、启动模板配置、S3 导出配置、 EC2 快速启动配置和 Systems Manager 参数配置。配置仅适用于源账户中的分布式映像，但可以跨账户应用的 SSM 参数配置除外。

默认超时：360 分钟

最大超时：720 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: ApplyImageConfigurations
  action: ApplyImageConfigurations
  onFailure: Abort
  inputs:
    distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

此步骤操作运行服务脚本来引导实例，以最低要求运行容器工作流。Image Builder 使用 Systems Manager API 中的 sendCommand 来运行此脚本。有关更多信息，请参阅 Amazon Systems Manager Run Command。

默认超时：60 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: ContainerBootstrapStep
  action: BootstrapInstanceForContainer
  onFailure: Abort
  inputs:
      instanceId.$: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

此步骤操作仅对构建工作流有效。

EC2 Image Builder 在其启动的 EC2 实例上运行 Amazon Systems Manager （Systems Manager）代理，以构建和测试您的映像。Image Builder 使用 Systems Manager 清单，以收集在构建阶段使用的实例的其他信息。该信息包括操作系统 (OS) 名称和版本，以及操作系统报告的软件包及其相应版本的列表。

默认超时：30 分钟

回滚：Image Builder 会回滚在此步骤中创建的所有 Systems Manager 资源。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: CollectMetadataStep
  action: CollectImageMetadata
  onFailure: Abort
  inputs:
      instanceId: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作的输出。

$.stepOutputs.CollectMetadataStep.osVersion

CollectImageScanFindings

如果您的账户启用了 Amazon Inspector，并且您的管道启用了映像扫描，则此步骤操作会收集 Amazon Inspector 为您的测试实例报告的映像扫描调查发现。此步骤操作不适用于构建工作流。

默认超时：120 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: CollectFindingsStep
  action: CollectImageScanFindings
  onFailure: Abort
  inputs:
      instanceId.$: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.CollectFindingsStep.status

CreateImage

此步骤操作使用 Amazon EC2 CreateImage API 从正在运行的实例创建映像。在创建过程中，步骤操作会根据需要进行等待，以验证资源是否已达到正确的状态，然后再继续后续操作。

默认超时：720 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: CreateImageFromInstance
  action: CreateImage
  onFailure: Abort
  inputs:
      instanceId.$: "i-1234567890abcdef0"

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.CreateImageFromInstance.imageId

DistributeImage

此步骤操作将 AMI 分发到指定的区域和账户。它根据工作流程中提供的 CreateImage CreateImagePipeline APIs或和/或自定义分发设置请求中提供的分配配置在目标区域和账户中创建 AMI 的副本，以覆盖分发配置中的设置。

默认超时：360 分钟

最大超时：720 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: DistributeImage
  action: DistributeImage
  onFailure: Abort
  inputs:
    distributions:
      - region.$: "$.parameters.SourceRegion"
        description: "AMI distribution to source region"
        amiTags:
          DistributionTest: "SourceRegion"
          WorkflowStep: "DistributeToSourceRegion"
          BuildDate: "{{imagebuilder:buildDate:yyyyMMHHss}}"
          BuildVersion: "{{imagebuilder:buildVersion}}"
		  

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.DistributeImageStep.distributedImages

ExecuteComponents

此步骤操作会运行配方中为当前正在构建的映像指定的组件。构建工作流在构建实例上运行构建组件。测试工作流仅在测试实例上运行测试组件。

Image Builder 使用 Systems Manager API 中的 sendCommand 来运行组件。有关更多信息，请参阅 Amazon Systems Manager Run Command。

默认超时：720 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: ExecComponentsStep
  action: ExecuteComponents
  onFailure: Abort
  inputs:
      instanceId: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作的输出。

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

此步骤操作从 Image Builder 工作流程中开始执行 Amazon Step Functions 状态机。Image Builder 使用 Step Functions StartExecution API 启动状态机并等待状态机完成。这对于将复杂的工作流程、合规性验证或认证流程集成到您的图像构建管道中非常有用。

有关更多信息，请参阅《Amazon Step Functions 开发者指南》中的 Step Functions 中了解状态机。

默认超时：6 小时

最大超时：24 小时

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

需要 IAM 权限

您的自定义执行角色必须具有以下权限才能使用此步骤操作：

示例

在工作流文档中指定步骤操作。

- name: ValidateImageCompliance
  action: ExecuteStateMachine
  timeoutSeconds: 3600
  onFailure: Abort
  inputs:
    stateMachineArn: arn:aws:states:us-west-2:111122223333:stateMachine:ImageComplianceValidation
    input: |
      {
        "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}",
        "region": "us-west-2",
        "complianceLevel": "high",
        "requiredScans": ["cve", "benchmark", "configuration"]
      }

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.ValidateImageCompliance.executionArn

LaunchInstance

此步骤操作将在您的中启动一个实例， Amazon Web Services 账户 并等待 Systems Manager 代理在该实例上运行，然后再继续下一步操作。启动操作使用与您的映像关联的配方和基础设施配置资源中的设置。例如，要启动的实例类型来自基础设施配置。输出是其启动的实例的实例 ID。

waitFor 输入会配置满足步骤完成要求的条件。

默认超时：60 分钟

回滚：对于构建实例，回滚会执行您在基础设施配置资源中配置的操作。默认情况下，如果映像创建失败，则会终止构建实例。但是，基础设施配置中有一个设置，用于保留构建实例以进行故障排除。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: LaunchStep
  action: LaunchInstance
  onFailure: Abort
  inputs:
    waitFor: ssmAgent

在工作流文档中使用步骤操作的输出。

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

此步骤操作修改分布式的属性 AMIs，例如启动权限和其他 AMI 属性。它对 AMIs 已分配给目标地区和账户的内容进行操作。

默认超时：120 分钟

最大超时时间：180 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: ModifyImageAttributes
  action: ModifyImageAttributes
  onFailure: Abort
  inputs:
    distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

此步骤操作使用亚马逊 API 注册新的亚马逊系统映像 (AM EC2 RegisterImage I)。它允许您根据现有快照或一组快照创建 AMI，并指定各种图像属性。

默认超时：720 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: RegisterNewImage
  action: RegisterImage
  onFailure: Abort
  inputs:
    architecture: "x86_64"
    bootMode: "uefi"
    blockDeviceMapping:
      - DeviceName: "/dev/sda1"
        Ebs:
          SnapshotId: "snap-1234567890abcdef0"
          VolumeSize: 100
          VolumeType: "gp3"
    rootDeviceName: "/dev/sda1"
    virtualizationType: "hvm"

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.RegisterNewImage.imageId

示例： SnapshotId 来自另一个步骤，生成的 AMI 中包含快照标签

- name: CreateSnapshot
  action: RunCommand
  onFailure: Abort
  inputs:
    instanceId: "i-1234567890abcdef0"
    documentName: "AWS-RunShellScript"
    parameters:
      commands:
        - "aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description 'Snapshot for AMI' --query 'SnapshotId' --output text"

- name: RegisterImageFromSnapshot
  action: RegisterImage
  onFailure: Abort
  inputs:
    architecture: "x86_64"
    bootMode: "uefi"
    blockDeviceMapping:
      - DeviceName: "/dev/sda1"
        Ebs:
          SnapshotId.$: "$.stepOutputs.CreateSnapshot.output[0]"
          VolumeSize: 100
          VolumeType: "gp3"
    includeSnapshotTags: true
    rootDeviceName: "/dev/sda1"
    virtualizationType: "hvm"

RunCommand

此步骤操作为您的工作流运行命令文档。Image Builder 使用 Systems Manager API 中的 sendCommand 来为您运行命令文档。有关更多信息，请参阅 Amazon Systems Manager Run Command。

默认超时：12 小时

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: RunCommandDoc
  action: RunCommand
  onFailure: Abort
  inputs:
    documentName: SampleDocument
    parameters:
        osPlatform: 
          - "linux"
    instanceId.$: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.RunCommandDoc.status

RunSysPrep

此步骤操作使用 Systems Manager API 中的 sendCommand 为 Windows 实例运行 AWSEC2-RunSysprep 文档，然后为快照关闭构建实例。这些操作遵循了强化和清理图像 Amazon 的最佳实践。

默认超时：60 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: RunSysprep
  action: RunSysPrep
  onFailure: Abort
  inputs:
      instanceId.$: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.RunSysprep.status

SanitizeInstance

此操作步骤会运行适用于 Linux 实例的推荐清理脚本，然后为快照关闭构建实例。清理脚本可帮助确保最终映像遵循安全最佳实践，并删除不应延续到快照中的构建构件或设置。有关脚本的更多信息，请参阅需要在构建后进行清理。此步骤操作不适用于容器映像。

Image Builder 使用 Systems Manager API 中的 sendCommand 来运行此脚本。有关更多信息，请参阅 Amazon Systems Manager Run Command。

默认超时：60 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: SanitizeStep
  action: SanitizeInstance
  onFailure: Abort
  inputs:
      instanceId: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.SanitizeStep.status

TerminateInstance

此步骤操作使用作为输入传入的实例 id 终止实例。

默认超时：30 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：此步骤操作没有输出。

示例

在工作流文档中指定步骤操作。

- name: TerminateInstance
  action: TerminateInstance
  onFailure: Continue
  inputs:
      instanceId.$: i-1234567890abcdef0

WaitForAction

此步骤操作会暂停正在运行的工作流，并等待接收来自 Image Builder SendWorkflowStepAction API 操作的外部操作。此步骤使用详细信息类型将 EventBridge 事件发布到您的默认 EventBridge 事件总线EC2 Image Builder Workflow Step Waiting。如果您提供 SNS 主题 ARN，则该步骤还可以发送 SNS 通知；如果您提供 Lambda 函数名称，则该步骤还可以异步调用 Lambda 函数。

默认超时：3 天

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在带有 SNS 通知的工作流程文档中指定步骤操作。

- name: SendEventAndWait
  action: WaitForAction
  onFailure: Abort
  inputs:
    snsTopicArn: arn:aws:sns:us-west-2:111122223333:ExampleTopic

使用 Lambda 函数调用在工作流程文档中指定步骤操作。

- name: SendEventAndWaitWithLambda
  action: WaitForAction
  onFailure: Abort
  inputs:
    lambdaFunctionName: ExampleFunction
    payload: |
      {
        "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}",
        "region": "us-west-2"
      }

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.SendEventAndWait.reason

WaitForSSMAgent

此步骤操作等待 EC2 实例在预期的无响应时间 Amazon Systems Manager 之后变得可控。它对于存在已知实例中断的工作流程（例如系统重启、操作系统升级或暂时断开实例与 SSM 连接的特定于平台的操作）特别有用。Image Builder 会监控该实例，直到它恢复 SSM 连接或超时。

默认超时：60 分钟

最大超时时间：180 分钟

回滚：此步骤操作没有回滚。

输入：下表包含此步骤操作支持的输入。

输出：下表包含此步骤操作的输出。

示例

在工作流文档中指定步骤操作。

- name: WaitForInstanceAfterReboot
  action: WaitForSSMAgent
  onFailure: Abort
  timeoutInSeconds: 900 # 15 minutes
  inputs:
    instanceId.$: $.stepOutputs.LaunchStep.instanceId

在工作流文档中使用步骤操作值的输出。

$.stepOutputs.WaitForInstanceAfterReboot.Status