本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

工作流程文件支援的步驟動作

本節包含 Image Builder 支援的步驟動作詳細資訊。

下表顯示哪些工作流程階段支援每個步驟動作。核取記號 (X) 表示您可以在該階段使用步驟動作。Image Builder 會將一些動作限制在特定階段： ExecuteComponents 限制為建置和測試階段、 CollectImageScanFindings限制為測試階段， 限制DistributeImageModifyImageAttributesApplyImageConfigurationsDistributeContainerImage為分佈階段。您可以在任何階段使用任何其他動作。

ApplyImageConfigurations

使用此步驟動作將各種組態和整合套用至分散式 AMIs，例如授權組態、啟動範本組態、S3 匯出組態、EC2 Fast Launch 組態和 Systems Manager 參數組態。組態僅適用於來源帳戶中的分散式映像，但可跨帳戶套用的 SSM 參數組態除外。

預設逾時：360 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。distributedImages.$ 輸入為必要項目。其餘資料列說明configurations陣列中每個項目內的欄位。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: ApplyImageConfigurations
  action: ApplyImageConfigurations
  onFailure: Abort
  inputs:
    distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages
    configurations:
      - region: us-west-2
        licenseConfigurationArns:
          - arn:aws:license-manager:us-west-2:111122223333:license-configuration:lic-example

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

此步驟動作會執行服務指令碼，以最低需求引導執行個體執行容器工作流程。Image Builder 使用 Systems Manager API sendCommand中的 來執行此指令碼。如需詳細資訊，請參閱AWS Systems Manager 執行命令。

預設逾時：60 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

此步驟動作僅適用於建置工作流程。

EC2 Image Builder 會在啟動的 EC2 執行個體上執行 AWS Systems Manager (Systems Manager) Agent，以建置和測試您的映像。Image Builder 會收集有關 Systems Manager 庫存建置階段期間所用執行個體的其他資訊。此資訊包括作業系統 (OS) 名稱和版本，以及您作業系統報告的套件清單及其個別版本。

預設逾時：30 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：Image Builder 會回復此步驟期間建立的任何 Systems Manager 資源。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作的輸出。

$.stepOutputs.CollectMetadataStep.osVersion

CollectImageScanFindings

如果您的帳戶已啟用 Amazon Inspector，且您的管道已啟用映像掃描，此步驟動作會收集 Amazon Inspector 為您的測試執行個體回報的映像掃描問題清單。此步驟動作不適用於建置工作流程。

預設逾時：120 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.CollectFindingsStep.status

CreateImage

此步驟動作會使用 Amazon EC2 CreateImage API 從執行中的執行個體建立映像。在建立過程中，步驟動作會視需要等待，以確認資源已達到正確的狀態，再繼續執行。

預設逾時：720 分鐘

最大逾時：3 天 (259，200 秒）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.CreateImageFromInstance.imageId

CreateImageFromIso

使用此步驟動作，從建置執行個體上的 ISO 磁碟映像建立 Amazon Machine Image (AMI)。當您的來源是 ISO 檔案而非基礎 AMI 時，請在建置工作流程中使用它。Image Builder 會將 ISO 轉換為 AMI，並等待資源達到所需狀態再繼續。

預設逾時：720 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: CreateImageFromIsoStep
  action: CreateImageFromIso
  onFailure: Abort
  inputs:
      instanceId.$: $.stepOutputs.LaunchStep.instanceId

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.CreateImageFromIsoStep.amiName

DistributeContainerImage

使用此步驟動作，將建置階段建立的容器映像分發至為映像定義之目標區域中的 Amazon ECR 儲存庫。在容器 (DOCKER) 映像的分佈工作流程中使用此動作。它可做為 的容器映像對應項目DistributeImage。

此步驟動作會在建置執行個體上執行 Systems Manager 命令，以推送容器映像。執行個體必須 AWS CLI 已安裝 Docker 和 。如需詳細資訊，請參閱BootstrapInstanceForContainer。

預設逾時：120 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: DistributeContainer
  action: DistributeContainerImage
  onFailure: Abort
  inputs:
      instanceId.$: $.stepOutputs.LaunchStep.instanceId

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.DistributeContainer.status

DistributeImage

此步驟動作會將 AMI 分佈到您指定的目標區域和帳戶。它使用來自 CreateImage或 CreateImagePipeline請求的分佈組態，或工作流程中覆寫預設組態的自訂分佈設定。

預設逾時：360 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- 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中的 來執行元件。如需詳細資訊，請參閱AWS Systems Manager 執行命令。

預設逾時：720 分鐘

最大逾時：1 天 (24 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作的輸出。

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

此步驟動作會從映像建置器工作流程開始執行 AWS Step Functions 狀態機器。Image Builder 使用 Step Functions StartExecution API 啟動狀態機器並等待其完成。這有助於將複雜的工作流程、合規驗證或認證程序整合到您的映像建置管道。

如需詳細資訊，請參閱《 AWS Step Functions 開發人員指南》中的了解 Step Functions 中的狀態機器。

預設逾時：6 小時

最大逾時：24 小時

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

所需的 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

使用此步驟動作在 中啟動執行個體 AWS 帳戶。動作會等到執行個體符合指定的運作狀態檢查條件，且 Systems Manager 代理程式正在執行，再繼續進行下一個步驟。啟動動作會使用來自配方和基礎設施組態資源的設定。例如，要啟動的執行個體類型來自基礎設施組態。輸出是啟動之執行個體的執行個體 ID。

waitFor 輸入會設定滿足步驟完成要求的條件。healthCheck 輸入指定在步驟繼續之前必須通過的 EC2 執行個體運作狀態驗證層級。

預設逾時：75 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：對於建置執行個體，回復會執行您在基礎設施組態資源中設定的動作。根據預設，如果映像建立失敗，則會終止建置執行個體。不過，基礎設施組態中有一項設定，可保留建置執行個體以進行故障診斷。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: LaunchStep
  action: LaunchInstance
  onFailure: Abort
  inputs:
    healthCheck: "RUNNING"
    waitFor: ssmAgent

使用工作流程文件中步驟動作的輸出。

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

使用此步驟動作來修改分散式 AMIs的屬性，例如啟動許可和其他 AMI 屬性。它在已分發至目標區域和帳戶的 AMIs 上運作。

預設逾時：120 分鐘

最大逾時：180 分鐘 (3 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: ModifyImageAttributes
  action: ModifyImageAttributes
  onFailure: Abort
  inputs:
    distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages
    attributes:
      - region: us-west-2
        launchPermission:
          userIds:
            - "111122223333"

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

此步驟動作會使用 Amazon EC2 RegisterImage API 註冊新的 Amazon Machine Image (AMI)。 RegisterImage 它可讓您從現有的快照或一組快照建立 AMI，並指定各種影像屬性。

預設逾時：540 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

所需的 IAM 許可

您的自訂執行角色必須具有下列許可，才能使用此步驟動作：

範例

在工作流程文件中指定步驟動作。

- 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中的 為您執行。如需詳細資訊，請參閱AWS Systems Manager 執行命令。

預設逾時：720 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- 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的文件。這些動作遵循AWS 強化和清理映像的最佳實務。

預設逾時：60 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.RunSysprep.status

SanitizeInstance

此步驟動作會在建置執行個體關閉快照之前，為 Linux 執行個體執行建議的淨化指令碼。淨化指令碼有助於確保最終映像遵循安全最佳實務，並移除不應傳遞至快照的建置成品或設定。如需指令碼的詳細資訊，請參閱 必要的建置後清除。此步驟動作不適用於容器映像。

Image Builder 使用 Systems Manager API sendCommand中的 來執行此指令碼。如需詳細資訊，請參閱AWS Systems Manager 執行命令。

預設逾時：60 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

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

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.SanitizeStep.status

TerminateInstance

此步驟動作會終止您使用instanceId輸入指定的執行個體。根據預設，它會啟動終止，並在不等待的情況下移至下一個步驟。如果終止遇到 EC2 服務錯誤，背景程序會處理清除。若要等待完全終止再繼續，請將waitForTermination輸入設定為 true。

預設逾時：30 分鐘

最大逾時：720 分鐘 (12 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：此步驟動作沒有輸出。

範例

在工作流程文件中指定步驟動作。

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

WaitForAction

此步驟動作會暫停執行中的工作流程，並等待從映像建置器 SendWorkflowStepAction API 動作接收外部動作。此步驟會將 EventBridge 事件發佈至具有詳細資訊類型 的預設 EventBridge 事件匯流排EC2 Image Builder Workflow Step Waiting。如果您提供 SNS 主題 ARN，步驟也可以傳送 SNS 通知，或者如果您提供 Lambda 函數名稱，也可以非同步叫用 Lambda 函數。

暫停和繼續的運作方式

步驟WaitForAction執行時，Image Builder 會將步驟狀態設定為 ，WAITING並發佈 EventBridge 事件 （詳細資訊類型 EC2 Image Builder Workflow Step Waiting)。如果您提供 snsTopicArn，也會傳送 Amazon SNS 通知。如果您提供 lambdaFunctionName，它會以非同步方式叫用該函數。工作流程會保持暫停，直到發生下列其中一種情況：

您傳遞至 reason 的 SendWorkflowStepAction會與 步驟一起存放，並可供後續步驟做為步驟的reason輸出。

預設逾時：3 天

最大逾時：7 天 (604，800 秒）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

所需的 IAM 許可

您的自訂執行角色必須具有下列許可，才能使用此步驟動作：

範例

使用 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 執行個體變成可由 AWS Systems Manager 管理。對於已知執行個體中斷的工作流程特別重要，例如系統重新啟動、作業系統升級，或暫時中斷執行個體與 SSM 連線的平台特定操作。Image Builder 會監控執行個體，直到它重新取得 SSM 連線或逾時為止。

預設逾時：60 分鐘

最大逾時：180 分鐘 (3 小時）

您可以使用 覆寫預設值timeoutSeconds，最多可達顯示的最大值。超過上限的值會驗證失敗。

回復：此步驟動作沒有回復。

輸入：下表包含此步驟動作支援的輸入。

輸出：下表包含此步驟動作的輸出。

範例

在工作流程文件中指定步驟動作。

- name: WaitForInstanceAfterReboot
  action: WaitForSSMAgent
  onFailure: Abort
  timeoutSeconds: 900
  inputs:
    instanceId.$: $.stepOutputs.LaunchStep.instanceId

使用工作流程文件中步驟動作值的輸出。

$.stepOutputs.WaitForInstanceAfterReboot.status