Acciones de paso admitidas para el documento de flujos de trabajo - EC2 Image Builder

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Acciones de paso admitidas para el documento de flujos de trabajo

En esta sección se incluyen detalles de las acciones de paso que admite Generador de imágenes.

Términos que se usan en esta sección
AMI

Imagen de máquina de Amazon

ARN

Nombre de recurso de Amazon

ApplyImageConfigurations

Este paso aplica varias configuraciones e integraciones a las distribuidas AMIs, como las configuraciones de licencias, las configuraciones de plantillas de lanzamiento, las configuraciones de exportación de S3, las configuraciones de EC2 Fast Launch y las configuraciones de parámetros de Systems Manager. Las configuraciones se aplican a las imágenes distribuidas solo en la cuenta de origen, excepto a las configuraciones de parámetros de SSM, que se pueden aplicar entre cuentas.

Tiempo de espera predeterminado: 360 minutos

Tiempo de espera máximo: 720 minutos

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
region La región de la imagen. Cadena
licenseConfigurationArns El ARN de configuración de licencia de la imagen. Matriz No
launchTemplateConfigurations Matriz No
launchTemplateConfigurations:launchTemplateId El ID de la plantilla de lanzamiento que se va a aplicar a la imagen. Cadena Sí, si launchTemplateConfigurations está especificado
launchTemplateConfigurations: ID de cuenta La cuenta de la plantilla de lanzamiento que se va IDs a aplicar a la imagen. Cadena No
launchTemplateConfigurations:setDefaultVersion La configuración de versión predeterminada de la plantilla de lanzamiento para la imagen. Booleano No
s3 ExportConfiguration Matriz No
S3ExportConfiguration: Nombre del rol El nombre del rol de configuración de exportación de S3 para la imagen. Cadena Sí, si s3ExportConfiguration está especificado
s3ExportConfiguration: diskImageFormat El formato de imagen de disco de configuración de exportación S3 para la imagen. Cadena Sí, si s3ExportConfiguration se especifica Valores permitidos: VMDK|RAW|VHD
S3ExportConfiguration: Cubeta S3 El nombre del depósito de configuración de exportación de S3 de la imagen. Cadena Sí, si s3ExportConfiguration está especificado
S3: prefijo S3 ExportConfiguration El prefijo del depósito de configuración de exportación de S3 para la imagen. Cadena No
fastLaunchConfigurations La configuración de EC2 Fast Launch de la imagen. Matriz No
fastLaunchConfigurationsLa configuración de inicio rápido de la imagen. ----sep----:enabled EC2 Inicio rápido enabled/disabled de la imagen. Booleano Sí, si fastLaunchConfigurations se especifica
fastLaunchConfigurationsSí, si se especifica ----SEP----:SnapshotConfiguration EC2 Inicio enabled/disabled rápido de la imagen. Asignación No
fastLaunchConfigurationsInicio rápido de la imagen. ----SEP----:SnapshotConfiguration: targetResourceCount EC2 El recuento de recursos objetivo de Fast Launch para la imagen. Entero No
fastLaunchConfigurations:maxParallelLaunches EC2 Fast Launch: máximo de lanzamientos paralelos de la imagen. Entero No
fastLaunchConfigurationsLanzamiento rápido: máximo de lanzamientos paralelos para la imagen. ----SEP----:LaunchTemplate No
fastLaunchConfigurations:LaunchTemplate ----SEP----:LaunchTemplate: launchTemplateId EC2 ID de plantilla de lanzamiento de Fast Launch para la imagen. Cadena No
fastLaunchConfigurationsID de plantilla de lanzamiento rápido para la imagen. ----SEP----:LaunchTemplate: launchTemplateName EC2 Nombre de la plantilla de lanzamiento de Fast Launch para la imagen. Cadena No
fastLaunchConfigurationsNombre de la plantilla de lanzamiento de Fast Launch para la imagen. ----SEP----:LaunchTemplate: launchTemplateVersion EC2 Versión de la plantilla de lanzamiento rápido para la imagen. Cadena No
ssmParameterConfigurations La configuración del parámetro SSM para la imagen. Asignación No
ssmParameterConfigurations:amiAccountId El ID de la cuenta AMI del parámetro SSM de la imagen. Cadena No
ssmParameterConfigurationsEl ID de la cuenta AMI del parámetro SSM para la imagen. ----SEP----:ParameterName El nombre del parámetro SSM de la imagen. Cadena Sí, si ssmParameterConfigurations está especificado
ssmParameterConfigurationsSí, si se especifica ----SEP----:DataType El tipo de datos del parámetro SSM de la imagen. Cadena No Valores permitidos: text|aws:ec2:image)

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
Imágenes configuradas Una lista de imágenes configuradas. Matriz
Imágenes configuradas: ID de cuenta El ID de cuenta de destino de la imagen distribuida. Cadena
Imágenes configuradas: nombre El nombre de la AMI. Cadena
Imágenes configuradas: un ID El ID de AMI de la imagen distribuida. Cadena
Imágenes configuradas: fecha de inicio Hora UTC en la que comenzó la distribución. Cadena
Imágenes configuradas: fecha en que se detuvo Hora UTC en la que se completó la distribución. Cadena
Imágenes configuradas: paso Paso en el que se detuvo la distribución. Completado | | AssociateLicensesRunning | UpdateLaunchTemplateRunning | PutSsmParametersRunning | UpdateFastLaunchConfiguration ExportAmiQueued ExportAmiRunning
Imágenes configuradas: región El tono de la imagen distribuida AWS Cadena
Imágenes configuradas: estado Estado de distribución. Completada | Fallada | Cancelada | TimedOut
Imágenes configuradas: mensaje de error Mensaje de error, si lo hay. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

Esta acción de paso ejecuta un script de servicio para arrancar la instancia con los requisitos mínimos para ejecutar flujos de trabajo de contenedores. Generador de imágenes utiliza la acción sendCommand en la API de Systems Manager para ejecutar este script. Para obtener más información, consulte AWS Systems Manager Run Command.

nota

El script de arranque instala los paquetes AWS CLI y Docker que son requisitos previos para que Image Builder compile correctamente los contenedores de Docker. Si no incluye esta acción de paso, la creación de la imagen podría producir un error.

Tiempo de espera predeterminado: 60 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia que se va a arrancar. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó el script de arranque en la instancia. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

Esta acción de paso solo es válida para los flujos de trabajo de creación.

EC2 Image Builder ejecuta el agente AWS Systems Manager (Systems Manager) en las EC2 instancias que lanza para crear y probar la imagen. Generador de Imágenes recopila información adicional sobre la instancia utilizada durante la fase de compilación con Systems Manager Inventory. Esta información incluye el nombre y la versión del sistema operativo (OS), así como la lista de paquetes y sus versiones respectivas, según lo indicado por su sistema operativo.

nota

Esta acción de paso solo funciona con las imágenes que se crean AMIs.

Tiempo de espera predeterminado: 30 minutos.

Restauración: Generador de imágenes restaura todos los recursos de Systems Manager que se hayan creado durante este paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId Instancia de creación en la que se aplicará la configuración de metadatos. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia de creación para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
osVersion Nombre y versión del sistema operativo recopilados de la instancia de creación. Cadena
associationId ID de asociación de Systems Manager utilizado para la recopilación del inventario. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.CollectMetadataStep.osVersion

CollectImageScanFindings

Si Amazon Inspector está habilitado para la cuenta y el análisis de imágenes está habilitado para la canalización, este paso de acción recopila los resultados del análisis de imágenes notificados por Amazon Inspector para la instancia de prueba. Esta acción de paso no está disponible para los flujos de trabajo de creación.

Tiempo de espera predeterminado: 120 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia en la que se ejecutó el análisis. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó el script para recopilar los resultados. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.CollectFindingsStep.status

CreateImage

Esta acción de paso crea una imagen a partir de una instancia en ejecución con la EC2 CreateImage API de Amazon. Durante el proceso de creación, la acción de paso espera lo necesario para comprobar que los recursos han alcanzado el estado correcto antes de continuar.

Tiempo de espera predeterminado: 720 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId Instancia desde la que se va a crear la nueva imagen. Cadena La instancia del ID de instancia proporcionado debe encontrarse en estado running cuando se inicie este paso.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
imageId ID de la AMI de la imagen que se crea. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.CreateImageFromInstance.imageId

DistributeImage

Esta acción de paso distribuye una AMI a regiones y cuentas específicas. Crea copias de la AMI en las regiones y cuentas de destino en función de la configuración de distribución proporcionada en las solicitudes CreateImage CreateImagePipeline APIs o de la configuración de distribución personalizada proporcionada en el flujo de trabajo para anular la configuración de distribución.

Tiempo de espera predeterminado: 360 minutos

Tiempo de espera máximo: 720 minutos

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
region La lista de regiones para distribuir la imagen. Cadena Longitud mínima de 1. La longitud máxima es 1024.
name El nombre de la configuración de distribución. Cadena No
description Las distribuciones de la configuración de distribución. Cadena No
targetAccountIds Cuenta IDs a la que se va a distribuir la imagen. Matriz No
Ami Tags Las etiquetas de la configuración de distribución. Asignación No
kmsKeyId Claves de KMS que se van a aplicar a la imagen distribuida. Cadena No

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
Imágenes distribuidas Una lista de imágenes distribuidas Matriz
Imágenes distribuidas: región La AWS región de la imagen distribuida. Cadena
Imágenes distribuidas: nombre El nombre de la AMI. Cadena
Imágenes distribuidas: un MIID El ID de AMI de la imagen distribuida. Cadena
Imágenes distribuidas: ID de cuenta El ID de cuenta de destino de la imagen distribuida. Cadena
Imágenes distribuidas: fecha de inicio Hora UTC en la que comenzó la distribución. Cadena
Imágenes distribuidas: fecha en la que se detuvo Hora UTC en la que se completó la distribución. Cadena
Imágenes distribuidas: estado Estado de distribución. Completada | Fallada | Cancelada | TimedOut
Imágenes distribuidas: paso 2 Paso en el que se detuvo la distribución. Completado| CopyAmiRunning
Imágenes distribuidas: mensaje de error Mensaje de error, si lo hay. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

- 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}}"

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.DistributeImageStep.distributedImages

ExecuteComponents

Esta acción de paso ejecuta los componentes que se especifican en la receta de la imagen actual que se está creando. Los flujos de trabajo de creación ejecutan los componentes de creación en la instancia de creación. Los flujos de trabajo de prueba solo ejecutan los componentes de prueba en la instancia de prueba.

Generador de imágenes utiliza la acción sendCommand en la API de Systems Manager para ejecutar los componentes. Para obtener más información, consulte AWS Systems Manager Run Command.

Tiempo de espera predeterminado: 720 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia en la que deben ejecutarse los componentes. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó los componentes en la instancia. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

Esta acción de paso inicia la ejecución de una máquina de AWS Step Functions estados desde un flujo de trabajo de Image Builder. Image Builder utiliza la StartExecution API Step Functions para iniciar la máquina de estados y espera a que finalice. Esto resulta útil para integrar flujos de trabajo complejos, procesos de validación de conformidad o certificación en su proceso de creación de imágenes.

Para obtener más información, consulte Más información sobre las máquinas de estado en Step Functions de la Guía para AWS Step Functions desarrolladores.

Tiempo de espera predeterminado: 6 horas

Tiempo de espera máximo: 24 horas

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
stateMachineArn El ARN de la máquina de estado de Step Functions que se va a ejecutar. Cadena Debe ser un ARN de máquina de estado válido.
input Datos de entrada JSON para proporcionarlos a la máquina de estados. Cadena No {} Debe ser una cadena JSON válida, longitud máxima: 16 KiB.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
executionArn El ARN de la ejecución de la máquina de estados. Cadena

Se requieren permisos de IAM

Su función de ejecución personalizada debe tener los siguientes permisos para utilizar esta acción escalonada:

Permitir acciones
  • states:StartExecution

  • states:DescribeExecution

Especifique los recursos
  • arn:aws:states:us-west-2:111122223333:stateMachine:state-machine-name

  • arn:aws:states:us-west-2:111122223333:execution:state-machine-name:*

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

- 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"] }

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.ValidateImageCompliance.executionArn

LaunchInstance

Esta acción de paso lanza una instancia en su Cuenta de AWS cuenta y espera a que el agente de Systems Manager se ejecute en la instancia antes de pasar al siguiente paso. La acción de lanzamiento utiliza las opciones de la receta y los recursos de configuración de la infraestructura asociados a la imagen. Por ejemplo, el tipo de instancia que se va a lanzar proviene de la configuración de la infraestructura. La salida es el ID de la instancia que se lanzó.

La entrada waitFor configura la condición que cumple con el requisito de finalización del paso.

Tiempo de espera predeterminado: 60 minutos.

Restauración: en el caso de las instancias de creación, la restauración realiza la acción que se configuró en el recurso de configuración de la infraestructura. De forma predeterminada, las instancias de creación se terminan si se produce un error en la creación de la imagen. Sin embargo, hay una opción en la configuración de la infraestructura para conservar la instancia de creación para la resolución de problemas.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
imageIdOverride La imagen que se utilizará para lanzar la instancia Cadena No

Etapa de construcción: imagen, receta, imagen base

Etapa de prueba: AMI de salida desde la etapa de compilación

Debe ser un ID de AMI válido
instanceTypesOverride Image Builder prueba cada tipo de instancia de la lista hasta encontrar uno que se inicie correctamente. Lista de cadena No Tipos de instancias especificados en la configuración de su infraestructura Deben ser tipos de instancia válidos
waitFor La condición que hay que esperar antes de completar el paso del flujo de trabajo y pasar al siguiente paso Cadena Generador de Imágenes es compatible con ssmAgent.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
instanceId ID de la instancia que se lanzó. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

Esta acción de paso modifica los atributos de la distribución AMIs, como los permisos de lanzamiento y otros atributos de la AMI. Funciona sobre los AMIs que se han distribuido a las regiones y cuentas de destino.

Tiempo de espera predeterminado: 120 minutos.

Tiempo de espera máximo: 180 minutos

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
region La región de la imagen. Cadena
Permiso de lanzamiento No
Permiso de inicio: ID de usuario El usuario que debe modificar IDs los permisos de lanzamiento de la imagen. Cadena No
Permiso de lanzamiento: grupos de usuarios Los grupos de usuarios que se van a modificar en los permisos de lanzamiento de la imagen. Cadena No
Permiso de lanzamiento: ARN de la organización La AWS organización que se va ARNs a modificar en los permisos de lanzamiento de la imagen. Cadena No
Permiso de lanzamiento: organizationalUnitArns La unidad AWS organizativa ARNs que se modificará en los permisos de lanzamiento de la imagen. Cadena No

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
Imágenes modificadas Una lista de imágenes modificadas Matriz
Imágenes modificadas: ID de cuenta El ID de cuenta de destino de la imagen distribuida. Cadena
Imágenes modificadas: nombre El nombre de la AMI. Cadena
Imágenes modificadas: un ID El ID de AMI de la imagen distribuida. Cadena
Imágenes modificadas: fecha de inicio Hora UTC en la que comenzó la distribución. Cadena
Imágenes modificadas: fecha de interrupción Hora UTC en la que se completó la distribución. Cadena
Imágenes modificadas: paso Paso en el que se detuvo la distribución. Completado| ModifyAmiRunning
Imágenes modificadas: región La AWS región de la imagen. Cadena
Imágenes modificadas: estado Estado de distribución. Completada | Fallada | Cancelada | TimedOut
Imágenes modificadas: mensaje de error Mensaje de error, si lo hay. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

Esta acción de paso registra una nueva imagen de máquina de Amazon (AMI) mediante la EC2 RegisterImage API de Amazon. Le permite crear una AMI a partir de una instantánea o conjunto de instantáneas existentes, especificando varios atributos de imagen.

Tiempo de espera predeterminado: 720 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
arquitectura La arquitectura de la AMI. Cadena No Valores válidos: i386, x86_64, arm64, x86_64_mac, arm64_mac
blockDeviceMapping Las entradas de mapeo de dispositivos de bloques para la AMI. Matriz No
Modo de arranque El modo de arranque de la AMI. Cadena No Valores válidos: legacy-bios, uefi, uefi-preferred
description Descripción de la AMI. Cadena No
enaSupport Si están habilitadas las redes mejoradas con ENA. Booleano No
Ubicación de la imagen La ubicación del manifiesto de la AMI. Cadena No Necesario para versiones respaldadas por S3 AMIs
Soporte para iMDS El nivel de IMDSv2 soporte. Cadena No Valores válidos: v2.0
includeSnapshotTags Si se deben incluir las etiquetas de la primera instantánea definida en el mapeo de dispositivos de bloques. Booleano No FALSO

Si se establece en true, las etiquetas se incluyen de la siguiente manera:

  • Las etiquetas del primer volumen SnapshotId de EBS de la blockDeviceMapping lista que contiene un SnapshotId se combinan con las etiquetas de registro de la AMI.

  • Las etiquetas de registro AMI tienen prioridad sobre las etiquetas de instantáneas con la misma clave.

  • AWS las etiquetas reservadas (aquellas cuyas claves comienzan poraws:) se excluyen automáticamente.

  • Si SnapshotId se definen varios volúmenes de EBS con, solo se incluyen las etiquetas del primer volumen de EBS de la lista que contenga SnapshotId un.

ID del núcleo El ID del núcleo que se va a utilizar. Cadena No
ID del disco RAM El ID del disco RAM que se va a utilizar. Cadena No
rootDeviceName El nombre del dispositivo raíz. Cadena No Ejemplo: /dev/sda1
sriovNetSupport Redes mejoradas con la interfaz Intel 82599 VF. Cadena No
Soporte TPM Compatibilidad con la versión TPM. Cadena No Valores válidos: v2.0
Datos UEFI Datos UEFI codificados en Base64. Cadena No
Tipo de virtualización El tipo de virtualización. Cadena No Valores válidos: hvm, paravirtual

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
imageId El ID de AMI de la imagen registrada. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

- 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"

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.RegisterNewImage.imageId

Ejemplo con etiquetas SnapshotId from another step y snapshot incluidas en la AMI generada

- 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

Esta acción de paso ejecuta un documento de comandos para el flujo de trabajo. Generador de imágenes utiliza la acción sendCommand en la API de Systems Manager para ejecutarlo automáticamente. Para obtener más información, consulte AWS Systems Manager Run Command.

Tiempo de espera predeterminado: 12 horas.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia en la que se va a ejecutar el documento de comandos. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.
documentName Nombre del documento de comandos de Systems Manager que se va a ejecutar. Cadena
parameters Lista de pares clave-valor para cualquier parámetro que requiera el documento de comandos. dictionary<string, list<string>> Condicional
documentVersion Versión del documento de comandos que se va a ejecutar. Cadena No $DEFAULT

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó el documento de comandos en la instancia. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Lista de cadenas

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.RunCommandDoc.status

RunSysPrep

Esta acción de paso utiliza la acción sendCommand en la API de Systems Manager para ejecutar el documento AWSEC2-RunSysprep para las instancias de Windows antes de que la instancia de creación se cierre para la instantánea. Estas acciones siguen las prácticas AWS recomendadas para endurecer y limpiar la imagen.

Tiempo de espera predeterminado: 60 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia en la que se va a ejecutar el documento AWSEC2-RunSysprep. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó el documento AWSEC2-RunSysprep en la instancia. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.RunSysprep.status

SanitizeInstance

Esta acción de paso ejecuta el script de saneamiento recomendado para las instancias de Linux antes de que la instancia de creación se cierre para la instantánea. El script de saneamiento ayuda a garantizar que la imagen final siga las prácticas recomendadas de seguridad y que se eliminen los artefactos u opciones de creación que no deban transferirse a la instantánea. Para obtener más información sobre el script, consulte Limpieza posterior a la creación necesaria. Esta acción de paso no se aplica a las imágenes de contenedor.

Generador de imágenes utiliza la acción sendCommand en la API de Systems Manager para ejecutar este script. Para obtener más información, consulte AWS Systems Manager Run Command.

Tiempo de espera predeterminado: 60 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia que se va a sanear. Cadena Debe ser el ID de la instancia de salida del paso del flujo de trabajo que lanzó la instancia para este flujo de trabajo.

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
runCommandId ID de la acción sendCommand de Systems Manager que ejecutó el script de saneamiento en la instancia. Cadena
status Estado devuelto por la acción sendCommand de Systems Manager. Cadena
salida Salida devuelta por la acción sendCommand de Systems Manager. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.SanitizeStep.status

TerminateInstance

Esta acción de paso termina la instancia con el ID de instancia que se pasa como entrada.

Tiempo de espera predeterminado: 30 minutos.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId ID de la instancia que se va a terminar. Cadena

Salidas: no hay salidas para esta acción de paso.

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

WaitForAction

Esta acción de paso pausa el flujo de trabajo en ejecución y espera a recibir una acción externa de la acción SendWorkflowStepAction de la API de Generador de imágenes. Este paso publica un EventBridge evento en el bus de EventBridge eventos predeterminado con un tipo EC2 Image Builder Workflow Step Waiting de detalle. El paso también puede enviar una notificación de SNS si proporciona un ARN de tema de SNS o invocar una función de Lambda de forma asíncrona si proporciona un nombre de función de Lambda.

Tiempo de espera predeterminado: 3 días.

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
snsTopicArn ARN de un tema de SNS opcional al que enviar una notificación cuando el paso del flujo de trabajo esté pendiente. Cadena No
lambdaFunctionName Un nombre o ARN opcional de la función Lambda para invocar de forma asíncrona cuando el paso del flujo de trabajo esté pendiente. Cadena No
payload Cadena JSON utilizada como mensaje para SNS y carga útil para Lambda. Si se proporciona, se incluye una carga útil personalizada de forma predeterminada. message/payload, used for SNS and Lambda respectively. If not provided, generates default message/payload Cadena No Debe ser una cadena JSON válida, máximo 16 KiB

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
acción Acción que devuelve la acción SendWorkflowStepAction de la API. Cadena (RESUME o STOP)
razón Motivo de la acción devuelta. Cadena

Ejemplo

Especifique la acción del paso en el documento de flujo de trabajo con la notificación de SNS.

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

Especifique la acción del paso en el documento de flujo de trabajo con la invocación de la función Lambda.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.SendEventAndWait.reason

WaitForSSMAgent

Esta acción escalonada espera a que una EC2 instancia se pueda administrar AWS Systems Manager después de los períodos esperados de falta de respuesta. Resulta especialmente útil para los flujos de trabajo con interrupciones conocidas de la instancia, como los reinicios del sistema, las actualizaciones del sistema operativo o las operaciones específicas de la plataforma que desconectan temporalmente la instancia del SSM. Image Builder supervisa la instancia hasta que recupera la conectividad SSM o se agota el tiempo de espera.

Tiempo de espera predeterminado: 60 minutos.

Tiempo de espera máximo: 180 minutos

Restauración: no hay ninguna restauración para esta acción de paso.

Entradas: en la siguiente tabla se incluyen las entradas admitidas para esta acción de paso.

Nombre de la entrada Description (Descripción) Tipo Obligatorio/a Predeterminado/a Restricciones
instanceId El ID de la instancia que se va a supervisar para comprobar la conectividad SSM. Cadena Debe ser un ID de EC2 instancia válido

Salidas: en la siguiente tabla se incluyen las salidas de esta acción de paso.

Nombre de salida Description (Descripción) Tipo
Status Estado de conexión del agente SSM. Cadena

Ejemplo

Especifique la acción de paso en el documento de flujos de trabajo.

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

Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.

$.stepOutputs.WaitForInstanceAfterReboot.Status