本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
工作流程文档支持的步骤操作
本节详细介绍了 Image Builder 支持的步骤操作。
本节中使用的术语
- AMI
-
亚马逊机器映像
- 进行筛选
-
Amazon 资源名称
下表显示了哪些工作流阶段支持每个步骤操作。复选标记 (X) 表示您可以在该阶段使用步骤操作。映像生成器将一些操作限制在特定阶段: ExecuteComponents 到构建和测试阶段, CollectImageScanFindings 进入测试阶段,然后 DistributeImage, ModifyImageAttributes, ApplyImageConfigurations,以及 DistributeContainerImage 进入分发阶段。你可以在任何阶段使用所有其他动作。
| 分步操作 | 构建 | 测试 | 分配 | 注意 |
|---|---|---|---|---|
| LaunchInstance | X | X | X | 启动亚马逊 EC2 实例。 |
| BootstrapInstanceForContainer | X | X | X | 安装 Docker 和 Amazon CLI 用于容器构建。 |
| ExecuteComponents | X | X | 在实例上运行组件。仅限于构建和测试阶段。 | |
| CollectImageMetadata | X | X | X | 仅限 AMI 构建。 |
| RunSysPrep | X | X | X | Windows 构建。 |
| SanitizeInstance | X | X | X | Linux AMI 构建;不适用于容器。 |
| CreateImage | X | X | X | 从构建实例创建 AMI。 |
| CreateImageFromIso | X | X | X | 从 ISO 磁盘映像创建 AMI。 |
| RegisterImage | X | X | X | 通过快照注册 AMI。 |
| DistributeContainerImage | X | 分发容器镜像。仅限于分发阶段。 | ||
| CollectImageScanFindings | X | 收集图像扫描结果。仅限于测试阶段。需要亚马逊检查员。 | ||
| RunCommand | X | X | X | 运行一个 Amazon Systems Manager (系统管理器)命令文档。 |
| WaitForSSMAgent | X | X | X | 重新启动后等待系统管理器连接。 |
| WaitForAction | X | X | X | 暂停执行外部操作。 |
| ExecuteStateMachine | X | X | X | 运行 Step Functions 状态机。 |
| TerminateInstance | X | X | X | 终止实例。例如,容器分发工作流程在推送映像后终止构建实例。 |
| DistributeImage | X | 将 AMI 复制到区域和账户。仅限于分发阶段。 | ||
| ModifyImageAttributes | X | 修改 AMI 启动权限。仅限于分发阶段。 | ||
| ApplyImageConfigurations | X | 应用启动模板、许可证、导出、快速启动和系统管理器参数。仅限于分发阶段。 |
单个工作流程分发 AMI 或容器映像,而不是同时分发。如果工作流程包括 DistributeContainerImage,它也不能包括 DistributeImage, ModifyImageAttributes,或 ApplyImageConfigurations。这些 AMI 分发操作在 Amazon EC2 AMI 上运行,而 DistributeContainerImage 对亚马逊弹性容器注册表 (亚马逊 ECR) 中的容器映像进行操作。
支持的操作
ApplyImageConfigurations
使用此步骤操作将各种配置和集成应用到分布式 AMI,例如许可证配置、启动模板配置、S3 导出配置、EC2 快速启动配置和 Systems Manager 参数配置。配置仅适用于源账户中的分布式映像,可以跨账户应用的 SSM 参数配置除外。
这个 configurations 输入是可选的。如果您提供,Image Builder 将使用您的工作流程输入并忽略附加的分发配置。如果省略它,Image Builder 将退回到连接到管道或映像的分发配置。
默认超时: 360 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。这个 distributedImages.$ 输入为必填项。其余行描述了每个项目中的字段 configurations 数组。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 分布式图片。$ | 要配置的分布式映像列表。参考 distributedImages 从 a 的输出 DistributeImage 步入相同的工作流程。 |
字符串 | 是 | 以开头的 JsonPath 参考文档 $.stepOutputs. |
|
| 配置 | 适用于分布式 AMI 的配置,如列表所示。每件物品都以一个为目标 Amazon 地区。 | 数组 | 否 | ||
| 配置:区域 | 这个 Amazon 要配置的分布式 AMI 的区域。 | 字符串 | 是 | 中的每件商品均为必填项 configurations。 |
|
| 配置:许可证ConfigurationArns | 映像的许可证配置 ARN。 | 数组 | 否 | ||
| 配置:启动TemplateConfigurations | 适用于分布式 AMI 的启动模板配置。 | 数组 | 否 | ||
| 配置:启动TemplateConfigurations:launchTemplateId | 应用于映像的启动模板 ID。 | 字符串 | 是的,如果 launchTemplateConfigurations 已指定 |
||
| 配置:启动TemplateConfigurations:accountId | 要应用于映像的启动模板账户 ID。 | 字符串 | 否 | ||
| 配置:启动TemplateConfigurations:setDefaultVersion | 映像的启动模板默认版本设置。 | 布尔值 | 否 | ||
| 配置:s3ExportConfiguration | 分布式 AMI 的 Amazon S3 导出配置。 | 数组 | 否 | ||
| 配置:s3ExportConfiguration:roleName | 映像的 Amazon S3 导出配置角色名称。 | 字符串 | 是的,如果 s3ExportConfiguration 已指定 |
||
| 配置:s3ExportConfiguration:diskImageFormat | 映像的 Amazon S3 导出配置磁盘映像格式。 | 字符串 | 是的,如果 s3ExportConfiguration 已指定 |
允许的值-VMDK|RAW|VHD | |
| 配置:s3ExportConfiguration:s3Bucket | 映像的 Amazon S3 导出配置存储桶名称。 | 字符串 | 是的,如果 s3ExportConfiguration 已指定 |
||
| 配置:s3ExportConfiguration:s3Prefix | 映像的 Amazon S3 导出配置存储桶前缀。 | 字符串 | 否 | ||
| 配置:快速LaunchConfigurations | 镜像的亚马逊 EC2 快速启动配置。 | 数组 | 否 | ||
| 配置:快速LaunchConfigurations:enabled | 是否为映像启用 Amazon EC2 快速启动。 | 布尔值 | 是的,如果 fastLaunchConfigurations 已指定 |
||
| 配置:快速LaunchConfigurations:snapshotConfiguration | 用于预配置 Amazon EC2 快速启动快照的快照配置。 | Map | 否 | ||
| 配置:快速LaunchConfigurations:snapshotConfiguration:targetResourceCount | 该映像的 Amazon EC2 快速启动目标资源数。 | 整数 | 否 | ||
| 配置:快速LaunchConfigurations:maxParallelLaunches | 亚马逊 EC2 快速启动映像的最大并行启动次数。 | 整数 | 否 | ||
| 配置:快速LaunchConfigurations:launchTemplate | Amazon EC2 快速启动用于准备预置快照的启动模板。 | Map | 否 | ||
| 配置:快速LaunchConfigurations:launchTemplate:launchTemplateId | 镜像的亚马逊 EC2 快速启动启动模板 ID。 | 字符串 | 否 | ||
| 配置:快速LaunchConfigurations:launchTemplate:launchTemplateName | 镜像的亚马逊 EC2 快速启动启动模板名称。 | 字符串 | 否 | ||
| 配置:快速LaunchConfigurations:launchTemplate:launchTemplateVersion | 该映像的亚马逊 EC2 快速启动启动模板版本。 | 字符串 | 否 | ||
| 配置:ssmParameterConfigurations | 映像的系统管理器参数配置。 | Map | 否 | ||
| 配置:ssmParameterConfigurations:amiAccountId | 映像的系统管理器参数 AMI 账户 ID。 | 字符串 | 否 | ||
| 配置:ssmParameterConfigurations:parameterName | 映像的系统管理器参数名称。 | 字符串 | 是的,如果 ssmParameterConfigurations 已指定 |
||
| 配置:ssmParameterConfigurations:dataType | 映像的系统管理器参数数据类型。 | 字符串 | 否 | 允许的值-文本|aws: ec2: image) |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 配置的映像 | 已配置映像的列表。 | 数组 |
| 已配置Images:accountId | 分布式映像的目标账户 ID。 | 字符串 |
| 已配置Images:name | AMI 的名称。 | 字符串 |
| 已配置Images:amiId | 分布式映像的 AMI ID。 | 字符串 |
| 已配置Images:dateStarted | 分发开始时的 UTC 时间。 | 字符串 |
| 已配置Images:dateStopped | 分发完成时的 UTC 时间。 | 字符串 |
| 已配置Images:step | 停止分发的步骤。 | 已完成|AssociateLicensesRunning|UpdateLaunchTemplateRunning|PutSsmParametersRunning|UpdateFastLaunchConfiguration|ExportAmiQueued|ExportAmiRunning |
| 已配置Images:region | 这个 Amazon 分布式图像的区域。 | 字符串 |
| 已配置Images:status | 分发状态。 | 已完成|失败|取消|TimedOut |
| 已配置Images:errorMessage | 错误消息(如果有)。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:ApplyImageConfigurationsaction: ApplyImageConfigurations onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages configurations: - region:us-west-2licenseConfigurationArns: - arn:aws:license-manager:us-west-2:111122223333:license-configuration:lic-example
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.ApplyImageConfigurationsStep.configuredImages
BootstrapInstanceForContainer
此步骤操作运行服务脚本来引导实例,以最低要求运行容器工作流。Image Builder 使用 Systems Manager API 中的 sendCommand 来运行此脚本。有关更多信息,请参阅 Amazon Systems Manager Run Command。
引导脚本会安装 Amazon CLI 以及 Docker 软件包,它们是映像生成器成功构建 Docker 容器的先决条件。如果未包含此步骤操作,映像构建可能会失败。
默认超时:60 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要引导的实例 ID。 | 字符串 | 是 | 这必须是启动此工作流实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 运行CommandId | 在实例上运行引导脚本的 Systems Manager sendCommand 的 ID。 | 字符串 |
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| output | 从 Systems Manager sendCommand 返回的输出。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:ContainerBootstrapStepaction: 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) 名称和版本,以及操作系统报告的软件包及其相应版本的列表。
此步骤操作仅适用于创建 AMI 的映像。
默认超时:30 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:Image Builder 会回滚在此步骤中创建的所有 Systems Manager 资源。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 应用元数据设置的构建实例。 | 字符串 | 是 | 这必须是启动此工作流构建实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| osVersion | 从构建实例收集的操作系统名称和版本。 | 字符串 |
| associationId | 用于清单收集的 Systems Manager 关联 ID。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:CollectMetadataStepaction: CollectImageMetadata onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作的输出。
$.stepOutputs.CollectMetadataStep.osVersion
CollectImageScanFindings
此步骤操作会收集 Amazon Inspector 针对您的测试实例或映像生成器推送到 Amazon ECR 的容器映像副本报告的图像扫描结果。您只能在测试工作流程中使用此步骤操作。它不适用于按需 AMI 扫描,Image Builder 使用 Amazon 管理 test-ami-scan 工作流程。有关更多信息,请参阅 AMI 扫描管理工作流程(test-ami-scan)。
默认超时: 15 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 对于 AMI,要扫描的测试实例的 ID。对于容器镜像,是将映像副本推送到 Amazon ECR 的实例的 ID。 | 字符串 | 是 | 在 AMI 测试工作流程中,使用启动实例的步骤的实例 ID 输出。在容器测试工作流程中,使用 $.workflowOutputs.InstanceId。 |
输出: 此步骤操作不生成输出。
示例
在工作流文档中指定步骤操作。
- name:CollectFindingsStepaction: CollectImageScanFindings onFailure: Abort if: booleanEquals: true value: "$.imagebuilder.collectImageScanFindings" inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
CreateImage
此步骤操作使用 Amazon EC2 CreateImage API 从正在运行的实例创建映像。在创建过程中,步骤操作会根据需要进行等待,以验证资源是否已达到正确的状态,然后再继续后续操作。
默认超时:720 分钟
最大超时: 3 天(259,200 秒)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要从中创建新映像的实例。 | 字符串 | 是 | 此步骤开始时,提供实例 ID 的实例必须处于 running 状态。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| imageId | 所创建映像的 AMI ID。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:CreateImageFromInstanceaction: CreateImage onFailure: Abort inputs: instanceId.$: "i-1234567890abcdef0"
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.CreateImageFromInstance.imageId
CreateImageFromIso
使用此步骤操作从构建实例上的 ISO 磁盘映像创建亚马逊系统映像 (AMI)。当您的源是 ISO 文件而不是基本 AMI 时,请在构建工作流程中使用它。映像生成器将 ISO 转换为 AMI,并等待资源达到所需状态后才能继续。
此操作与导入 ISO 磁盘映像的要求相同。有关更多信息,请参阅 使用映像生成器导入经过验证的 Windows ISO 磁盘映像。
默认超时:720 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 保存 ISO 磁盘映像的构建实例的 ID。 | 字符串 | 是 | 这必须是启动此工作流构建实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| amiName | 该步骤创建的 AMI 的名称。 | 字符串 |
| 快照ID | 支持 AMI 的快照的 ID。 | 字符串 |
| 架构 | AMI 的架构 (x86_64 要么 arm64)。 |
字符串 |
示例
在工作流文档中指定步骤操作。
- name:CreateImageFromIsoStepaction: CreateImageFromIso onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.CreateImageFromIsoStep.amiName
DistributeContainerImage
使用此步骤操作将构建阶段创建的容器映像分发到为该映像定义的目标区域中的 Amazon ECR 存储库。在容器的分发工作流程中使用此操作 (DOCKER) 图片。它可以用作容器映像的对应物 DistributeImage。
此步骤操作在构建实例上运行 Systems Manager 命令以推送容器镜像。该实例必须有 Docker 和 Amazon CLI 已安装。有关更多信息,请参阅 BootstrapInstanceForContainer。
工作流程包括 DistributeContainerImage 也不能包括 DistributeImage, ModifyImageAttributes,或 ApplyImageConfigurations。单个工作流程要么分发容器映像,要么分发 AMI,不能同时分发两者。
默认超时:120 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 保存容器镜像的构建实例的 ID。 | 字符串 | 是 | 这必须是启动此工作流构建实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| 成功的地区 | 成功分发的地区。 | 数组 |
| 失败的区域 | 分发失败的区域。 | 数组 |
示例
在工作流文档中指定步骤操作。
- name:DistributeContaineraction: DistributeContainerImage onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.DistributeContainer.status
DistributeImage
此步骤操作将 AMI 分发到您指定的目标区域和账户。它使用您的分发配置 CreateImage 要么 CreateImagePipeline 请求或工作流程中替代默认配置的自定义分发设置。
这个 distributions 输入是可选的。如果您提供,Image Builder 将使用您的工作流程输入并忽略附加的分发配置。如果省略它,Image Builder 将退回到连接到管道或映像的分发配置。
默认超时: 360 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 分配 | AMI 的分发设置,以列表形式列出。每件物品都以一个为目标 Amazon 地区。如果您省略此输入,Image Builder 将使用附加到管道或映像的分发配置。 | 数组 | 否 | ||
| 分布:区域 | 这个 Amazon 分发 AMI 的目标区域。 | 字符串 | 是 | 最小长度为 1。最大长度为 1024。 | |
| 发行版:名称 | 适用于分布式 AMI 的名称。 | 字符串 | 否 | ||
| 发行版:描述 | 适用于分布式 AMI 的描述。 | 字符串 | 否 | ||
| 分布:目标AccountIds | 向其分发 AMI 的账户 ID。 | 数组 | 否 | ||
| 发行版:amiTags | 应用于分布式 AMI 的标签。 | Map | 否 | 最多 50 个标签。 | |
| 发行版:kmsKeyId | 用于加密分布式 AMI 的 KMS 密钥。 | 字符串 | 否 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 分布式图像 | 分布式图像列表 | 数组 |
| 分散式的Images:region | 这个 Amazon 分布式图像的区域。 | 字符串 |
| 分散式的Images:name | AMI 的名称。 | 字符串 |
| 分散式的Images:amiId | 分布式映像的 AMI ID。 | 字符串 |
| 分散式的Images:accountId | 分布式映像的目标账户 ID。 | 字符串 |
| 分散式的Images:dateStarted | 分发开始时的 UTC 时间。 | 字符串 |
| 分散式的Images:dateStopped | 分发完成时的 UTC 时间。 | 字符串 |
| 分散式的Images:status | 分发状态。 | 已完成|失败|取消|TimedOut |
| 分散式的Images:step | 停止分发的步骤。 | 已完成|CopyAmiRunning |
| 分散式的Images:errorMessage | 错误消息(如果有)。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:DistributeImageaction: 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 分钟
最大超时: 1 天(24 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 组件应在其上运行的实例的 ID。 | 字符串 | 是 | 这必须是启动此工作流实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 运行CommandId | 在实例上运行组件的 Systems Manager sendCommand 的 ID。 | 字符串 |
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| output | 从 Systems Manager sendCommand 返回的输出。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:ExecComponentsStepaction: ExecuteComponents onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作的输出。
$.stepOutputs.ExecComponentsStep.status
ExecuteStateMachine
此步骤操作开始执行 Amazon Step Functions 图像生成器工作流程中的状态机。图像生成器使用步进函数 StartExecution 用于启动状态机并等待状态机完成的 API。这对于将复杂的工作流程、合规性验证或认证流程集成到您的映像构建管道中非常有用。
有关更多信息,请参阅 在 Step Functions 中了解状态机 在 Amazon Step Functions 开发者指南。
默认超时: 6 个小时
最大超时: 24 小时
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 州MachineArn | 要执行的步进函数状态机的 ARN。 | 字符串 | 是 | 必须是有效的状态机 ARN。 | |
| input | 提供给状态机的 JSON 输入数据。 | 字符串 | 否 | {} | 必须是有效的 JSON 字符串,最大长度:16 KiB。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 执行 Arn | 状态机执行的 ARN。 | 字符串 |
| output | 状态机执行的输出。 | 字符串 |
需要 IAM 权限
您的自定义执行角色必须具有以下权限才能使用此步骤操作:
允许操作
-
states:StartExecution -
states:DescribeExecution
指定资源
-
arn:aws:states:us-west-2:111122223333:stateMachine:state-machine-name -
arn:aws:states:us-west-2:111122223333:execution:state-machine-name:*
示例
在工作流文档中指定步骤操作。
- name:ValidateImageComplianceaction: ExecuteStateMachine timeoutSeconds: 3600 onFailure: Abort inputs: stateMachineArn: arn:aws:states:us-west-2:111122223333:stateMachine:ImageComplianceValidationinput: | { "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}", "region": "us-west-2", "complianceLevel": "high", "requiredScans": ["cve", "benchmark", "configuration"] }
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.ValidateImageCompliance.executionArn
LaunchInstance
使用此步骤操作在您的中启动实例 Amazon Web Services 账户。该操作将等到实例满足指定的运行状况检查条件并且 Systems Manager 代理运行后再继续下一步。启动操作使用您的配方和基础架构配置资源中的设置。例如,要启动的实例类型来自基础设施配置。输出是启动的实例的实例 ID。
在构建工作流程中,该操作使用已在运行的实例,而不是在您指定时启动实例 parentInstanceId,或者当您的基础设施配置有父实例时。有关更多信息,请参阅 在 Auto Scaling 组的实例上构建。
waitFor 输入会配置满足步骤完成要求的条件。这个 healthCheck 输入指定了在步骤继续之前必须通过的 EC2 实例运行状况验证级别。
默认超时: 75 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚: 对于构建实例,回滚执行您在基础架构配置资源中配置的操作。默认情况下,如果映像创建失败,则会终止构建实例。但是,基础设施配置中有一个设置,用于保留构建实例以进行故障排除。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 图像IdOverride | 用于启动实例的图像 | 字符串 | 否 |
构建阶段:图像配方基础镜像 测试阶段:从构建阶段输出 AMI |
必须是有效的 AMI ID |
| 实例TypesOverride | Image Builder 会尝试列表中的每种实例类型,直到找到成功启动的实例类型 | 字符串列表 | 否 | 基础设施配置中指定的实例类型 | 必须是有效的实例类型 |
| waitFor | 在完成工作流程步骤并继续下一步之前要等待的条件 | 字符串 | 是 | 无 | Image Builder 支持 ssmAgent。 |
| 健康检查 | 工作流程步骤继续之前所需的 EC2 运行状况验证级别。请指定 RUNNING 以最少的验证实现更快的构建,或 STATUS_CHECK_PASSED 等待 EC2 状态检查通过。 |
字符串 | 否 | STATUS_CHECK_PASSED |
有效值:RUNNING | STATUS_CHECK_PASSED。 |
| 父母InstanceId | 要构建的正在运行的实例的 ID,而不是启动新实例。仅适用于构建工作流程。默认情况下,映像生成器会在构建结束时终止实例。 | 字符串 | 否 | 无 | 必须是后面有 8 或 17 个小写十六进制字符的实例 ID i-。当你设置它时,映像生成器会忽略 imageIdOverride, instanceTypesOverride, userDataOverride,以及 healthCheck。 |
在现有实例上构建: 当你指定时 parentInstanceId,您的配方和基础架构配置中的启动设置不适用,以下规则适用:
-
该实例必须在同一个环境中运行 Amazon Web Services 账户 和 Amazon Web Services 区域 作为映像,运行与映像相同的平台和架构,不得由其他映像生成器工作流程使用。否则,该步骤将失败。
-
执行角色需要 EC2ImageBuilderExecutionPolicy 管理策略和
ec2:CreateTags在实例上。映像生成器使用以下方法标记实例CreatedBy: EC2 Image Builder,并且托管策略仅允许映像生成器在带有该标签的实例上运行命令、停止、创建映像和终止这些实例。这些标签也取代了实例的Name标签。如果标记失败,则该步骤会继续,但后续步骤将失败,除非实例已经有CreatedBy标签。以下示例策略允许角色标记两个实例:{ "Version": "2012-10-17", "Statement": [ { "Sid": "TagParentInstance", "Effect": "Allow", "Action": "ec2:CreateTags", "Resource": [ "arn:aws:ec2:us-west-2:111122223333:instance/i-0123456789abcdef0", "arn:aws:ec2:us-west-2:111122223333:instance/i-0fedcba9876543210" ] } ] } -
该实例必须能够运行 SSM 代理命令,对于容器构建, Docker。
-
映像生成器不会将实例与 Auto Scaling 组分离,而且
parentInstanceId在基础架构配置中,优先于父实例。测试工作流程会忽略它。 -
要在构建后保留实例,请设置
terminateInstanceOnCompletion和terminateInstanceOnFailure到false,然后跳过任何TerminateInstance何时采取行动terminateInstanceOnCompletion是false。有关更多信息,请参阅 TerminateInstance。
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| instanceId | 启动的实例的实例 ID,或操作改为使用的正在运行的实例的实例 ID。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:LaunchStepaction: LaunchInstance onFailure: Abort inputs: healthCheck: "RUNNING" waitFor:ssmAgent
在工作流文档中使用步骤操作的输出。
$.stepOutputs.LaunchStep.instanceId
使用以下构建工作流程在现有实例上构建。
parameters: - name: parentInstanceId type: string default: "" steps: - name: LaunchBuildInstance action: LaunchInstance onFailure: Abort inputs: waitFor: ssmAgent parentInstanceId.$: "$.parameters.parentInstanceId" # Your build steps go here. - name: TerminateBuildInstance action: TerminateInstance onFailure: Continue if: booleanEquals: true value: "$.imagebuilder.terminateInstanceOnCompletion" inputs: instanceId.$: "$.stepOutputs.LaunchBuildInstance.instanceId"
此工作流程执行以下操作:
-
parentInstanceId.$从中获取实例 IDparentInstanceId工作流程参数。有关更多信息,请参阅 工作流文档输入参数。 -
这个
if条件跳过TerminateBuildInstance什么时候$.imagebuilder.terminateInstanceOnCompletion是false。有关更多信息,请参阅 使用 Image Builder 系统变量。
ModifyImageAttributes
使用此步骤操作修改分布式 AMI 的属性,例如启动权限和其他 AMI 属性。它在已分发到目标地区和账户的 AMI 上运行。
这个 attributes 输入是可选的。如果您提供,Image Builder 将使用您的工作流程输入并忽略附加的分发配置。如果省略它,Image Builder 将退回到连接到管道或映像的分发配置。
默认超时:120 分钟
最大超时时间: 180 分钟(3 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 分布式图片。$ | 要修改的分布式图像列表。参考 distributedImages 从 a 的输出 DistributeImage 步入相同的工作流程。 |
字符串 | 是 | 以开头的 JsonPath 参考文档 $.stepOutputs. |
|
| 属性 | 要修改的图像属性,以列表形式列出。每件物品都以一个为目标 Amazon 地区。 | 数组 | 否 | ||
| 属性:区域 | 这个 Amazon 要修改的分布式 AMI 的区域。 | 字符串 | 是 | 中的每件商品均为必填项 attributes。 |
|
| 属性:启动权限 | 适用于分布式 AMI 的启动权限设置。 | Map | 否 | ||
| 属性:启动Permission:userIds | 要在 AMI 启动权限中添加或删除的账户 ID。 | 数组 | 否 | ||
| 属性:启动Permission:userGroups | 要在 AMI 启动权限中添加或删除的用户组。 | 数组 | 否 | ||
| 属性:启动Permission:organizationArns | 这个 Amazon 要添加或移除 AMI 启动权限的组织 ARN。 | 数组 | 否 | ||
| 属性:启动Permission:organizationalUnitArns | 要在 AMI 启动权限中添加或删除的组织单位 (OU) ARN。 | 数组 | 否 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 修改后的图片 | 修改后的图像列表 | 数组 |
| 已修改Images:accountId | 分布式映像的目标账户 ID。 | 字符串 |
| 已修改Images:name | AMI 的名称。 | 字符串 |
| 已修改Images:amiId | 分布式映像的 AMI ID。 | 字符串 |
| 已修改Images:dateStarted | 分发开始时的 UTC 时间。 | 字符串 |
| 已修改Images:dateStopped | 分发完成时的 UTC 时间。 | 字符串 |
| 已修改Images:step | 停止分发的步骤。 | 已完成|ModifyAmiRunning |
| 已修改Images:region | 这个 Amazon 图像的区域。 | 字符串 |
| 已修改Images:status | 分发状态。 | 已完成|失败|取消|TimedOut |
| 已修改Images:errorMessage | 错误消息(如果有)。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:ModifyImageAttributesaction: ModifyImageAttributes onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages attributes: - region:us-west-2launchPermission: userIds: - "111122223333"
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.ModifyImageAttributesStep.modifiedImages
RegisterImage
此步骤操作使用 Amazon EC2 注册新的亚马逊系统映像 (AMI) RegisterImage API。它允许您根据现有快照或一组快照创建 AMI,指定各种图像属性。
默认超时: 540 分钟
最大超时时间: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| 架构 | AMI 的架构。 | 字符串 | 否 | 有效值:i386、x86_64、arm64、x86_64_mac、arm64_mac | |
| 街区DeviceMapping | AMI 的块储存设备映射条目。 | 数组 | 否 | ||
| 启动模式 | AMI 的启动模式。 | 字符串 | 否 | 有效值:legacy-bios、uefi、uefi-perferred | |
| 描述 | AMI 的描述。 | 字符串 | 否 | ||
| enaSupport | 是否启用了 ENA 的增强联网。 | 布尔值 | 否 | ||
| 图像位置 | AMI 清单的位置。 | 字符串 | 否 | 为必填项 S3-backed AMI | |
| IMDS 支持 | IMDSv2 支持级别。 | 字符串 | 否 | 有效值:v2.0 | |
| 包括SnapshotTags | 是否包含块储存设备映射中定义的第一个快照中的标签。 | 布尔值 | 否 | FALSE |
当设置为 true 时,标签包含如下:
|
| kerneLid | 要使用的内核的 ID。 | 字符串 | 否 | ||
| ramdisKid | 要使用的 RAM 磁盘的 ID。 | 字符串 | 否 | ||
| 根DeviceName | 根设备的设备名称。 | 字符串 | 否 | 示例:/dev/sda1 | |
| sriovNetSupport | 使用英特尔 82599 VF 接口增强联网。 | 字符串 | 否 | ||
| TPM 支持 | TPM 版本支持。 | 字符串 | 否 | 有效值:v2.0 | |
| UEFI 数据 | Base64-encoded UEFI 数据。 | 字符串 | 否 | ||
| 虚拟化类型 | 虚拟化类型。 | 字符串 | 否 | 有效值:hvm、半虚拟化 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| imageId | 注册图像的 AMI ID。 | 字符串 |
需要 IAM 权限
您的自定义执行角色必须具有以下权限才能使用此步骤操作:
允许操作
-
ec2:DescribeSnapshots -
ec2:CreateTags
示例
在工作流文档中指定步骤操作。
- 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
带有 a 的示例 SnapshotId 从另一个步骤开始,生成的 AMI 中包含快照标签
- name: CreateSnapshot action: RunCommand onFailure: Abort inputs: instanceId: "i-1234567890abcdef0" documentName: "AWS-RunShellScript" parameters: commands: - "aws ec2 create-snapshot --volume-idvol-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。
默认超时:720 分钟
最大超时时间: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要在其上运行命令文档的实例的 ID。 | 字符串 | 是 | 这必须是启动此工作流实例的工作流步骤的输出实例 ID。 | |
| documentName | 要运行的 Systems Manager 命令文档的名称。 | 字符串 | 是 | ||
| 参数 | 命令文档所需的任何参数的键值对列表。 | dictionary<string, list<string>> | 有条件 | ||
| documentVersion | 要运行的命令文档版本。 | 字符串 | 否 | $DEFAULT |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 运行CommandId | 在实例上运行命令文档的 Systems Manager sendCommand 的 ID。 | 字符串 |
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| output | 从 Systems Manager sendCommand 返回的输出。 | 字符串列表 |
示例
在工作流文档中指定步骤操作。
- name:RunCommandDocaction: RunCommand onFailure: Abort inputs: documentName:SampleDocumentparameters: osPlatform: - "linux" instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.RunCommandDoc.status
RunSysPrep
此步骤操作使用 Systems Manager API 中的 sendCommand 为 Windows 实例运行 AWSEC2-RunSysprep 文档,然后为快照关闭构建实例。以下是这些操作 Amazon 强化和清理图像的最佳实践。。
默认超时:60 分钟
最大超时时间: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要在其上运行 AWSEC2-RunSysprep 文档的实例的 ID。 |
字符串 | 是 | 这必须是启动此工作流实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 运行CommandId | 在实例上运行 AWSEC2-RunSysprep 文档的 Systems Manager sendCommand 的 ID。 |
字符串 |
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| output | 从 Systems Manager sendCommand 返回的输出。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:RunSysprepaction: 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 分钟
最大超时: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要清理的实例的 ID。 | 字符串 | 是 | 这必须是启动此工作流实例的工作流步骤的输出实例 ID。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| 运行CommandId | 在实例上运行清理脚本的 Systems Manager sendCommand 的 ID。 | 字符串 |
| status | 从 Systems Manager sendCommand 返回的状态。 | 字符串 |
| output | 从 Systems Manager sendCommand 返回的输出。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:SanitizeStepaction: SanitizeInstance onFailure: Abort inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.SanitizeStep.status
TerminateInstance
此步骤操作将终止您使用指定的实例 instanceId 输入。默认情况下,它无需等待即可启动终止并进入下一步。如果终止时遇到 EC2 服务错误,后台进程会处理清理问题。要等待完全终止后再继续,请设置 waitForTermination 输入到 true。
terminateInstanceOnCompletion 不会覆盖此步骤。在什么时候保留实例 terminateInstanceOnCompletion 是 false,使用跳过该步骤 if 条件开启 $.imagebuilder.terminateInstanceOnCompletion,或者删除该步骤。
默认超时:30 分钟
最大超时时间: 720 分钟(12 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要终止的实例的 ID。 | 字符串 | 是 | 无 | 无 |
| 等待ForTermination | 指定该步骤是否等待实例达到终止状态后再继续。当设置为 true,该步骤将等待完全终止(10 秒到几分钟)。 |
布尔值 | 否 | false |
true | false |
输出:此步骤操作没有输出。
示例
在工作流文档中指定步骤操作。
- name:TerminateInstanceaction: TerminateInstance onFailure: Continue inputs: instanceId.$:i-1234567890abcdef0waitForTermination:false
在以下情况下跳过该步骤 terminateInstanceOnCompletion 是 false。
- name: TerminateBuildInstance action: TerminateInstance onFailure: Continue if: booleanEquals: true value: "$.imagebuilder.terminateInstanceOnCompletion" inputs: instanceId.$: "$.stepOutputs.LaunchBuildInstance.instanceId"
WaitForAction
此步骤操作会暂停正在运行的工作流,并等待接收来自 Image Builder 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,它还会发送亚马逊 SNS 通知。如果你提供 lambdaFunctionName,它异步调用该函数。工作流程将保持暂停状态,直到发生以下情况之一:
-
你打电话 SendWorkflowStepAction 和
RESUME继续,或STOP结束工作流程。 -
该步骤达到超时时间(默认 3 天,最长 7 天),工作流程失败。
这个 reason 你传递给的 SendWorkflowStepAction 与步骤一起存储,可作为该步骤的后续步骤使用 reason 输出。
默认超时:3 天
最大超时时间: 7 天(604,800 秒)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| snsTopicArn | 可选的 SNS 主题 ARN,用于在工作流步骤处于待处理状态时向其发送通知。 | 字符串 | 否 | 主题名称只能包含字母、数字、连字符和下划线。 | |
| lambdaFunctionName | 工作流程步骤处于待处理状态时异步调用的 Lambda 函数的可选名称或 ARN。 | 字符串 | 否 | ||
| payload | Image Builder 添加的可选值 customPayload 字段指向 Amazon SNS 通知、Lambda 负载或两者,具体取决于哪一个 snsTopicArn 和 lambdaFunctionName 你设置。映像生成器始终发送默认消息字段,如以下示例所示。如果您不提供有效负载,或者提供的负载为空,Image Builder 将仅发送默认字段。 |
字符串 | 否 | 最多 16,384 个字符。图像生成器不验证该值是否为格式正确的 JSON。 |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| action | SendWorkflowStepAction API 操作返回的操作。 | 字符串(RESUME 或 STOP) |
| reason | 返回操作的原因。 | 字符串 |
需要 IAM 权限
您的自定义执行角色必须具有以下权限才能使用此步骤操作:
允许操作
-
lambda:InvokeFunction—仅在设置时才需要lambdaFunctionName。 -
sns:Publish—仅在设置时才需要snsTopicArn。
指定资源
-
arn:aws:lambda:us-west-2:123456789012:function:function-name -
arn:aws:lambda:us-west-2:123456789012:function:* -
arn:aws:sns:us-west-2:123456789012:ExampleTopic
与基础架构配置状态通知不同, WaitForAction 该步骤需要收到亚马逊 SNS 通知才能成功。如果映像生成器无法发布到您在中指定的主题 snsTopicArn,该步骤失败。映像生成器会在调用您在中指定的函数之前发布 Amazon SNS 通知 lambdaFunctionName,因此发布失败也会阻止该调用。Lambda 调用失败也会使该步骤失败。Image Builder 异步调用该函数,因此函数本身引发的错误不会使该步骤失败。什么时候 onFailure 是 Abort,这是默认设置,工作流程会失败。什么时候 onFailure 是 Continue,工作流程将运行下一步。如果失败的步骤是工作流中的最后一个步骤,则即使该步骤失败,工作流也会报告为已完成。
Image Builder 在工作流程运行的区域调用 Amazon SNS,并使用图像的执行角色。如果镜像没有执行角色,则映像生成器使用服务相关角色。发布请求返回的任何错误都会使该步骤失败。
示例
使用 SNS 通知在工作流文档中指定步骤操作。
- name:SendEventAndWaitaction: WaitForAction onFailure: Abort inputs: snsTopicArn: arn:aws:sns:us-west-2:123456789012:ExampleTopic
当该步骤进入时 WAITING 状态,映像生成器将以下消息发布到您在中指定的主题 snsTopicArn。如果你指定 lambdaFunctionName,Image Builder 向该函数发送与有效负载相同的消息,并异步调用该函数。您可以单独设置任一输入,也可以同时设置两者。这个 customPayload 字段仅在您提供时出现 payload 价值。映像生成器首先解析一个 payload.$ JsonPath 参考以及任何 {{ }} 在 a 里面插值标记 payload 值,然后将结果添加到消息中。映像生成器不会将结果解析为 JSON。当你设置时 payload 到一个字符串, customPayload 是消息中的 JSON 字符串,因此请再次解析它以从中读取结构化数据。
{ "imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/my-image/1.0.0/1", "workflowArn": "arn:aws:imagebuilder:us-west-2:123456789012:workflow/build/my-workflow/1.0.0/1", "workflowExecutionId": "wf-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "workflowStepExecutionId": "step-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "workflowStepName": "SendEventAndWait", "version": "1.0", "customPayload": "{\"customMessage\": \"This is a custom payload\", \"imageId\": \"ami-12345\"}" }
这个 workflowArn 字段包含工作流程编译版本 ARN,该版本以编译版本号结尾。映像生成器将此 JSON 发布为亚马逊 SNS 消息正文。
使用 Lambda 函数调用在工作流程文档中指定步骤操作。
- name:SendEventAndWaitWithLambdaaction: WaitForAction onFailure: Abort inputs: lambdaFunctionName:ExampleFunctionpayload: | { "imageId": "{{ $.stepOutputs.CreateImageFromInstance.imageId }}", "region": "us-west-2" }
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.SendEventAndWait.reason
WaitForSSMAgent
此步骤操作将等待 EC2 实例变为可管理的 Amazon Systems Manager 在预期的无响应时间之后。它对于存在已知实例中断的工作流特别有价值,例如系统重启、操作系统升级或暂时断开实例与 SSM 连接的平台特定操作。映像生成器会监控实例,直到它恢复 SSM 连接或超时。
默认超时:60 分钟
最大超时时间: 180 分钟(3 小时)
你可以使用以下方法覆盖默认值 timeoutSeconds,直至所示的最大值。高于最大值的值无法通过验证。
回滚:此步骤操作没有回滚。
输入:下表包含此步骤操作支持的输入。
| 输入名称 | 说明 | 类型 | 必填 | 默认 | 约束 |
|---|---|---|---|---|---|
| instanceId | 要监控 SSM 连接的实例的 ID。 | 字符串 | 是 | 必须是有效的 EC2 实例 ID |
输出:下表包含此步骤操作的输出。
| 输出名称 | 说明 | 类型 |
|---|---|---|
| status | SSM 代理的连接状态。 | 字符串 |
示例
在工作流文档中指定步骤操作。
- name:WaitForInstanceAfterRebootaction: WaitForSSMAgent onFailure: Abort timeoutSeconds: 900 inputs: instanceId.$: $.stepOutputs.LaunchStep.instanceId
在工作流文档中使用步骤操作值的输出。
$.stepOutputs.WaitForInstanceAfterReboot.status