翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ワークフロードキュメントでサポートされているステップアクション

このセクションには、Image Builder がサポートするステップアクションの詳細が含まれています。

ApplyImageConfigurations

このステップアクションは、ライセンス設定、起動テンプレート設定、S3 エクスポート設定、EC2 Fast Launch 設定、Systems Manager AMIs に適用します。設定は、クロスアカウントに適用できる SSM パラメータ設定を除き、ソースアカウントの分散イメージにのみ適用されます。

デフォルトのタイムアウト: 360 分

最大タイムアウト: 720 分

ロールバック: このステップアクションにはロールバックはありません。

インプット: 以下の表には、このステップアクションでサポートされる入力が含まれています。

出力: 次の表には、このステップアクションの出力が含まれています。

例

ワークフロードキュメントでステップアクションを指定します。

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

ワークフロードキュメント内のステップアクション値の出力を使用します。

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

このステップアクションは、コンテナワークフローを実行するための最小要件でインスタンスをブートストラップするサービススクリプトを実行します。Image Builder は、Systems Manager API の sendCommand を使用してこのスクリプトを実行します。詳細については、「AWS Systems Manager Run Command」を参照してください。

デフォルトタイムアウト: 60 分

ロールバック: このステップアクションにはロールバックはありません。

インプット: 以下の表には、このステップアクションでサポートされる入力が含まれています。

出力: 次の表には、このステップアクションの出力が含まれています。

例

ワークフロードキュメントでステップアクションを指定します。

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

ワークフロードキュメント内のステップアクション値の出力を使用します。

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

このステップアクションはビルドワークフローでのみ有効です。

EC2 Image Builder は、イメージを構築してテストするために、起動した EC2 インスタンスで AWS 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 を使用してコンポーネントを実行します。詳細については、「AWS Systems Manager Run Command」を参照してください。

デフォルトタイムアウト: 720 分

ロールバック: このステップアクションにはロールバックはありません。

インプット: 以下の表には、このステップアクションでサポートされる入力が含まれています。

出力: 次の表には、このステップアクションの出力が含まれています。

例

ワークフロードキュメントでステップアクションを指定します。

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

ワークフロードキュメント内のステップアクションからの出力を使用します。

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

このステップアクションは、Image Builder ワークフローから AWS Step Functions ステートマシンの実行を開始します。Image Builder は Step Functions StartExecution API を使用してステートマシンを開始し、完了するのを待ちます。これは、複雑なワークフロー、コンプライアンス検証、または認証プロセスをイメージ構築パイプラインに統合するのに役立ちます。

詳細については、「 デベロッパーガイド」の「Step Functions でステートマシンについて学ぶ」を参照してください。 AWS 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

このステップアクションは、 でインスタンスを起動 AWS アカウント し、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

このステップアクションは、Amazon EC2 RegisterImage API を使用して新しい Amazon マシンイメージ (AMI) RegisterImage を登録します。これにより、既存のスナップショットまたはスナップショットのセットから 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 を使用して実行します。詳細については、「AWS 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 ドキュメントを実行します。これらのアクションはAWS 、イメージを強化およびクリーンアップするためのベストプラクティスに従います。

デフォルトタイムアウト: 60 分

ロールバック: このステップアクションにはロールバックはありません。

インプット: 以下の表には、このステップアクションでサポートされる入力が含まれています。

出力: 次の表には、このステップアクションの出力が含まれています。

例

ワークフロードキュメントでステップアクションを指定します。

- 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 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 インスタンスが予想される無応答期間後に によって AWS Systems Manager 管理可能になるまで待機します。これは、システムの再起動、OS のアップグレード、SSM からインスタンスを一時的に切断するプラットフォーム固有のオペレーションなど、インスタンスの中断が既知のワークフローに特に役立ちます。Image Builder は、SSM 接続が回復するかタイムアウトするまでインスタンスをモニタリングします。

デフォルトタイムアウト: 60 分

最大タイムアウト: 180 分

ロールバック: このステップアクションにはロールバックはありません。

インプット: 以下の表には、このステップアクションでサポートされる入力が含まれています。

出力: 次の表には、このステップアクションの出力が含まれています。

例

ワークフロードキュメントでステップアクションを指定します。

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

ワークフロードキュメント内のステップアクション値の出力を使用します。

$.stepOutputs.WaitForInstanceAfterReboot.Status