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
En la tabla siguiente se muestran las etapas del flujo de trabajo que admiten cada acción escalonada. Una marca de verificación (X) indica que puede usar la acción escalonada en esa etapa. Image Builder restringe algunas acciones a etapas específicas: ExecuteComponents a las etapas de creación y prueba, CollectImageScanFindings a la etapa de prueba y, DistributeImage ModifyImageAttributesApplyImageConfigurations, y DistributeContainerImage a la etapa de distribución. Puede usar cualquier otra acción en cualquier etapa.
| Acción escalonada | Build | Prueba | Distribución | Notas |
|---|---|---|---|---|
| LaunchInstance | X | X | X | Lanza una instancia de Amazon EC2. |
| BootstrapInstanceForContainer | X | X | X | Instala Docker y las compilaciones de contenedores AWS CLI . |
| ExecuteComponents | X | X | Ejecuta los componentes de la instancia. Se limita a las etapas de creación y prueba. | |
| CollectImageMetadata | X | X | X | Solo compilaciones de AMI. |
| RunSysPrep | X | X | X | Compilaciones de Windows. |
| SanitizeInstance | X | X | X | Compilaciones de AMI para Linux; no para contenedores. |
| CreateImage | X | X | X | Crea una AMI a partir de la instancia de compilación. |
| CreateImageFromIso | X | X | X | Crea una AMI a partir de una imagen de disco ISO. |
| RegisterImage | X | X | X | Registra una AMI a partir de instantáneas. |
| DistributeContainerImage | X | Distribuye una imagen de contenedor. Restringido a la etapa de distribución. | ||
| CollectImageScanFindings | X | Recopila los resultados del escaneo de imágenes. Restringido a la fase de prueba. Requiere Amazon Inspector y el escaneo de imágenes. | ||
| RunCommand | X | X | X | Ejecuta un documento de comandos AWS Systems Manager (del administrador de sistemas). |
| WaitForSSMAgent | X | X | X | Espera a que se conecte Systems Manager después de un reinicio. |
| WaitForAction | X | X | X | Hace una pausa para realizar una acción externa. |
| ExecuteStateMachine | X | X | X | Ejecuta una máquina de estados de Step Functions. |
| TerminateInstance | X | X | X | Termina una instancia. Por ejemplo, un flujo de trabajo de distribución de contenedores termina la instancia de creación después de enviar la imagen. |
| DistributeImage | X | Copia una AMI a regiones y cuentas. Se limita a la etapa de distribución. | ||
| ModifyImageAttributes | X | Modifica los permisos de inicio de la AMI. Restringido a la etapa de distribución. | ||
| ApplyImageConfigurations | X | Aplica las plantillas de lanzamiento, las licencias, las exportaciones, el inicio rápido y los parámetros de Systems Manager. Restringido a la fase de distribución. |
importante
Un único flujo de trabajo distribuye las AMI o las imágenes de contenedor, no ambas. Si un flujo de trabajo incluyeDistributeContainerImage, no puede incluir DistributeImage también oApplyImageConfigurations. ModifyImageAttributes Estas acciones de distribución de las AMI funcionan en las AMI de Amazon EC2, mientras que DistributeContainerImage en las imágenes de contenedor de Amazon Elastic Container Registry (Amazon ECR).
Acciones admitidas
ApplyImageConfigurations
Utilice este paso para aplicar diversas configuraciones e integraciones a las AMI distribuidas, como las configuraciones de licencias, las configuraciones de plantillas de lanzamiento, las configuraciones de exportación de S3, las configuraciones de lanzamiento rápido de EC2 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.
nota
La configurations entrada es opcional. Si la proporciona, Image Builder utiliza las entradas de su flujo de trabajo e ignora la configuración de distribución adjunta. Si la omite, Image Builder vuelve a la configuración de distribución adjunta a la canalización o la imagen.
Tiempo de espera predeterminado: 360 minutos
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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. La distributedImages.$ entrada es obligatoria. Las filas restantes describen los campos de cada elemento de la configurations matriz.
| Nombre de la entrada | Description (Descripción) | Tipo | Obligatorio/a | Predeterminado | Restricciones |
|---|---|---|---|---|---|
| Imágenes distribuidas. $ | La lista de imágenes distribuidas que se van a configurar. Haga referencia al distributedImages resultado de un DistributeImage paso del mismo flujo de trabajo. |
Cadena | Sí | Una referencia de JSONPath que comience por $.stepOutputs. |
|
| configurations | Las configuraciones que se van a aplicar a las AMI distribuidas, en forma de lista. Cada elemento se dirige a una AWS región. | Matriz | No | ||
| configuraciones: región | La AWS región de la AMI distribuida que se va a configurar. | Cadena | Sí | Necesario para cada elemento deconfigurations. |
|
| configuraciones: licencia ConfigurationArns | El ARN de configuración de la licencia para la imagen. | Matriz | No | ||
| configuraciones:iniciar TemplateConfigurations | Las configuraciones de la plantilla de lanzamiento que se aplicarán a las AMI distribuidas. | Matriz | No | ||
| configuraciones: lanzamiento TemplateConfigurations:launchTemplateId | El ID de la plantilla de lanzamiento que se va a aplicar a la imagen. | Cadena | Sí, si launchTemplateConfigurations está especificado |
||
| configuraciones: iniciar TemplateConfigurations:accountId | Los ID de cuenta de la plantilla de lanzamiento que se van a aplicar a la imagen. | Cadena | No | ||
| configuraciones:iniciar TemplateConfigurations:setDefaultVersion | La configuración de versión predeterminada de la plantilla de lanzamiento para la imagen. | Booleano | No | ||
| configuraciones: s3 ExportConfiguration | La configuración de exportación de Amazon S3 para las AMI distribuidas. | Matriz | No | ||
| configuraciones: s3 ExportConfiguration:roleName | El nombre del rol de configuración de exportación de Amazon S3 para la imagen. | Cadena | Sí, si s3ExportConfiguration está especificado |
||
| configuraciones: s3 ExportConfiguration:diskImageFormat | El formato de imagen de disco de configuración de exportación de Amazon S3 para la imagen. | Cadena | Sí, si s3ExportConfiguration está especificado |
Valores permitidos: VMDK|RAW|VHD | |
| configuraciones: s3 ExportConfiguration:s3Bucket | El nombre del bucket de configuración de exportación de Amazon S3 para la imagen. | Cadena | Sí, si s3ExportConfiguration está especificado |
||
| configuraciones: s3 ExportConfiguration:s3Prefix | El prefijo del bucket de configuración de exportación de Amazon S3 para la imagen. | Cadena | No | ||
| configuraciones: rápidas LaunchConfigurations | La configuración de Amazon EC2 Fast Launch para la imagen. | Matriz | No | ||
| configuraciones: rápidas LaunchConfigurations:enabled | Si Amazon EC2 Fast Launch está habilitado para la imagen. | Booleano | Sí, si fastLaunchConfigurations está especificado |
||
| configuraciones: rápidas LaunchConfigurations:snapshotConfiguration | La configuración de instantáneas para el aprovisionamiento previo de las instantáneas de Amazon EC2 Fast Launch. | Asignación | No | ||
| configuraciones: rápidas LaunchConfigurations:snapshotConfiguration:targetResourceCount | El recuento de recursos objetivo de Amazon EC2 Fast Launch para la imagen. | Entero | No | ||
| configuraciones: rápidas LaunchConfigurations:maxParallelLaunches | El Fast Launch de Amazon EC2 es el máximo de lanzamientos paralelos para la imagen. | Entero | No | ||
| configuraciones: rápidas LaunchConfigurations:launchTemplate | La plantilla de lanzamiento que Amazon EC2 Fast Launch utiliza para preparar las instantáneas previamente aprovisionadas. | Asignación | No | ||
| configuraciones: rápidas LaunchConfigurations:launchTemplate:launchTemplateId | El ID de la plantilla de lanzamiento rápido de Amazon EC2 para la imagen. | Cadena | No | ||
| configuraciones: rápidas LaunchConfigurations:launchTemplate:launchTemplateName | El nombre de la plantilla de lanzamiento rápido de Amazon EC2 para la imagen. | Cadena | No | ||
| configuraciones: rápidas LaunchConfigurations:launchTemplate:launchTemplateVersion | La versión de la plantilla de lanzamiento rápido de Amazon EC2 para la imagen. | Cadena | No | ||
| configuraciones: ssm ParameterConfigurations | La configuración de parámetros de Systems Manager para la imagen. | Asignación | No | ||
| configuraciones: ssm ParameterConfigurations:amiAccountId | El ID de la cuenta AMI del parámetro Systems Manager para la imagen. | Cadena | No | ||
| configuraciones: ssm ParameterConfigurations:parameterName | El nombre del parámetro de Systems Manager para la imagen. | Cadena | Sí, si ssmParameterConfigurations está especificado |
||
| configuraciones: ssm ParameterConfigurations:dataType | El tipo de datos de los parámetros de Systems Manager para 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 |
| configurado Images:accountId | El ID de la cuenta de destino de la imagen distribuida. | Cadena |
| configurado Images:name | El nombre de la AMI. | Cadena |
| configurado Images:amiId | El ID de AMI de la imagen distribuida. | Cadena |
| configurado Images:dateStarted | hora UTC en la que se inició la distribución. | Cadena |
| configurado Images:dateStopped | Hora UTC en la que se completó la distribución. | Cadena |
| configurado Images:step | El paso en el que se detuvo la distribución. | Completado| | AssociateLicensesRunning | UpdateLaunchTemplateRunning | PutSsmParametersRunning | UpdateFastLaunchConfiguration ExportAmiQueued ExportAmiRunning |
| configurado Images:region | La AWS región de la imagen distribuida. | Cadena |
| configurado Images:status | Estado de distribución. | Completado | Fallado | Cancelado | TimedOut |
| configurado Images:errorMessage | Mensaje de error, si lo hay. | Cadena |
Ejemplo
Especifique la acción de paso en el documento de flujos de trabajo.
- 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
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 bootstrap instala los paquetes Docker AWS CLI y Docker que son requisitos previos para que Image Builder cree correctamente los contenedores 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.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia que se va a arrancar. | Cadena | Sí | 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 |
|---|---|---|
| ejecutar CommandId | 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:ContainerBootstrapStepaction: 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.
Generador de imágenes de EC2 ejecuta AWS Systems Manager (Systems Manager) Agent en las instancias de EC2 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 crean AMI.
Tiempo de espera predeterminado: 30 minutos.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | Instancia de creación en la que se aplicará la configuración de metadatos. | Cadena | Sí | 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:CollectMetadataStepaction: 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.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia en la que se ejecutó el análisis. | Cadena | Sí | 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 |
|---|---|---|
| ejecutar CommandId | 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:CollectFindingsStepaction: 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 API CreateImage de Amazon EC2. 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.
Tiempo de espera máximo: 3 días (259,200 segundos)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | Instancia desde la que se va a crear la nueva imagen. | Cadena | Sí | 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:CreateImageFromInstanceaction: 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
CreateImageFromIso
Usa este paso para crear una imagen de máquina de Amazon (AMI) a partir de una imagen de disco ISO en la instancia de compilación. Utilícela en un flujo de trabajo de compilación cuando su fuente sea un archivo ISO en lugar de una AMI base. Image Builder convierte la ISO en una AMI y espera a que los recursos alcancen el estado requerido antes de continuar.
nota
Esta acción tiene los mismos requisitos que la importación de una imagen de disco ISO. Para obtener más información, consulte Importe imágenes de disco ISO de Windows verificadas con Image Builder.
Tiempo de espera predeterminado: 720 minutos.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | El ID de la instancia de compilación que contiene la imagen de disco ISO. | Cadena | Sí | 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 |
|---|---|---|
| amiName | El nombre de la AMI que creó el paso. | Cadena |
| ID de instantánea | El ID de la instantánea que respalda la AMI. | Cadena |
| arquitectura | La arquitectura de la AMI (x86_64oarm64). |
Cadena |
Ejemplo
Especifique la acción de paso en el documento de flujos de trabajo.
- name:CreateImageFromIsoStepaction: CreateImageFromIso 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.CreateImageFromIsoStep.amiName
DistributeContainerImage
Utilice este paso para distribuir una imagen de contenedor creada en la fase de creación en los repositorios de Amazon ECR de las regiones de destino definidas para la imagen. Utilice esta acción en un flujo de trabajo de distribución para imágenes de container (DOCKER). Funciona como la contraparte de la imagen contenedora de. DistributeImage
Esta acción escalonada ejecuta un comando de Systems Manager en la instancia de compilación para insertar la imagen del contenedor. La instancia debe tener Docker y el AWS CLI instalado. Para obtener más información, consulte BootstrapInstanceForContainer.
importante
Un flujo de trabajo que incluya DistributeContainerImage no puede incluir DistributeImage también oApplyImageConfigurations. ModifyImageAttributes Un único flujo de trabajo distribuye imágenes de contenedor o AMI, no ambas.
Tiempo de espera predeterminado: 120 minutos.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | El ID de la instancia de compilación que contiene la imagen del contenedor. | Cadena | Sí | 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 |
|---|---|---|
| status | Estado devuelto por la acción sendCommand de Systems Manager. | Cadena |
| Regiones sucedidas | Las regiones en las que la distribución tuvo éxito. | Matriz |
| Regiones fallidas | Las regiones en las que falló la distribución. | Matriz |
Ejemplo
Especifique la acción de paso en el documento de flujos de trabajo.
- name:DistributeContaineraction: DistributeContainerImage 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.DistributeContainer.status
DistributeImage
Esta acción escalonada distribuye una AMI a las regiones y cuentas de destino que especifique. Utiliza la configuración de distribución de su CreateImagePipeline solicitud CreateImage o la configuración de distribución personalizada del flujo de trabajo que anula la configuración predeterminada.
nota
La distributions entrada es opcional. Si la proporciona, Image Builder utiliza las entradas de su flujo de trabajo e ignora la configuración de distribución adjunta. Si la omite, Image Builder vuelve a la configuración de distribución adjunta a la canalización o la imagen.
Tiempo de espera predeterminado: 360 minutos
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| distribuciones | La configuración de distribución de la AMI, en forma de lista. Cada elemento se dirige a una AWS región. Si omite esta entrada, Image Builder utiliza la configuración de distribución adjunta a la canalización o la imagen. | Matriz | No | ||
| distribuciones: región | La AWS región a la que se distribuirá la AMI. | Cadena | Sí | Longitud mínima de 1. La longitud máxima es 1024. | |
| distribuciones:nombre | El nombre que se va a aplicar a la AMI distribuida. | Cadena | No | ||
| distribuciones: descripción | La descripción que se va a aplicar a la AMI distribuida. | Cadena | No | ||
| distribuciones: objetivo AccountIds | Los identificadores de cuenta a los que se va a distribuir la AMI. | Matriz | No | ||
| Distribuciones: etiquetas de AMI | Las etiquetas que se van a aplicar a la AMI distribuida. | Asignación | No | Máximo de 50 etiquetas. | |
| distribuciones: kms KeyId | La clave de KMS que se utilizará para cifrar la AMI 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 |
| distribuidas Images:region | La AWS región de la imagen distribuida. | Cadena |
| distribuida Images:name | El nombre de la AMI. | Cadena |
| distribuido Images:amiId | El ID de AMI de la imagen distribuida. | Cadena |
| distribuida Images:accountId | El ID de la cuenta de destino de la imagen distribuida. | Cadena |
| distribuida Images:dateStarted | Hora UTC en la que se inició la distribución. | Cadena |
| distribuido Images:dateStopped | Hora UTC en la que se completó la distribución. | Cadena |
| distribuido Images:status | Estado de distribución. | Completado | Fallado | Cancelado | TimedOut |
| distribuido Images:step | El paso en el que se detuvo la distribución. | Completado| CopyAmiRunning |
| distribuido Images:errorMessage | Mensaje de error, si lo hay. | Cadena |
Ejemplo
Especifique la acción de paso en el documento de flujos de trabajo.
- 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}}"
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.
Tiempo de espera máximo: 1 día (24 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia en la que deben ejecutarse los componentes. | Cadena | Sí | 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 |
|---|---|---|
| ejecutar CommandId | 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:ExecComponentsStepaction: 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 usa 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
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| estado MachineArn | El ARN de la máquina de estados de Step Functions que se va a ejecutar. | Cadena | Sí | 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, con una longitud máxima de 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 |
| salida | El resultado de la ejecución de la máquina de estados. | Cadena |
Se requieren permisos de IAM
Su rol de ejecución personalizado debe tener los siguientes permisos para usar 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: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"] }
Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.
$.stepOutputs.ValidateImageCompliance.executionArn
LaunchInstance
Utilice este paso para lanzar una instancia en su Cuenta de AWS. La acción espera hasta que la instancia cumpla la condición de verificación de estado especificada y el agente de Systems Manager esté en ejecución antes de continuar con el siguiente paso. La acción de lanzamiento utiliza la configuración de sus recursos de configuración de infraestructura y receta. Por ejemplo, el tipo de instancia que se va a lanzar proviene de la configuración de la infraestructura. El resultado es el ID de instancia de la instancia que se lanzó.
La entrada waitFor configura la condición que cumple con el requisito de finalización del paso. La healthCheck entrada especifica el nivel de validación del estado de la instancia EC2 que debe superar antes de continuar con el paso.
Tiempo de espera predeterminado: 75 minutos
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
Reversión: en el caso de las instancias de compilación, la reversión realiza la acción que ha configurado 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 | Restricciones |
|---|---|---|---|---|---|
| imagen IdOverride | La imagen que se utilizará para lanzar la instancia | Cadena | No |
Etapa de construcción: imagen, receta, imagen base Etapa de prueba: genera la AMI desde la etapa de construcción |
Debe ser un ID de AMI válido |
| instancia TypesOverride | Image Builder prueba cada tipo de instancia de la lista hasta que encuentra una que se inicie correctamente | Lista de cadena | No | Tipos de instancia especificados en la configuración de su infraestructura | Deben ser tipos de instancia válidos |
| waitFor | La condición a la que hay que esperar antes de completar el paso del flujo de trabajo y pasar al siguiente | Cadena | Sí | Ninguno | Generador de Imágenes es compatible con ssmAgent. |
| HealthCheck | El nivel de validación del estado de EC2 requerido antes de continuar con la etapa del flujo de trabajo. RUNNINGEspecifique si desea compilaciones más rápidas con una validación mínima o espere STATUS_CHECK_PASSED a que se aprueben las comprobaciones de estado de EC2. |
Cadena | No | STATUS_CHECK_PASSED |
Valores válidos: RUNNING | STATUS_CHECK_PASSED. |
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:LaunchStepaction: LaunchInstance onFailure: Abort inputs: healthCheck: "RUNNING" waitFor:ssmAgent
Utilice la salida de la acción de paso en el documento de flujos de trabajo.
$.stepOutputs.LaunchStep.instanceId
ModifyImageAttributes
Utilice este paso para modificar los atributos de las AMI distribuidas, como los permisos de lanzamiento y otros atributos de las AMI. Funciona en las AMI que se han distribuido a las regiones y cuentas de destino.
nota
La attributes entrada es opcional. Si la proporciona, Image Builder utiliza las entradas de su flujo de trabajo e ignora la configuración de distribución adjunta. Si la omite, Image Builder vuelve a la configuración de distribución adjunta a la canalización o la imagen.
Tiempo de espera predeterminado: 120 minutos.
Tiempo de espera máximo: 180 minutos (3 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| Imágenes distribuidas. $ | La lista de imágenes distribuidas que se van a modificar. Haga referencia al distributedImages resultado de un DistributeImage paso del mismo flujo de trabajo. |
Cadena | Sí | Una referencia de JSONPath que comience por $.stepOutputs. |
|
| attributes | Los atributos de la imagen que se van a modificar, en forma de lista. Cada elemento se dirige a una AWS región. | Matriz | No | ||
| atributos: región | La AWS región de la AMI distribuida que se va a modificar. | Cadena | Sí | Necesario para cada elemento deattributes. |
|
| Atributos: permiso de lanzamiento | La configuración de permisos de lanzamiento que se aplicará a la AMI distribuida. | Asignación | No | ||
| atributos: lanzar Permission:userIds | Los ID de cuenta que se van a agregar o eliminar de los permisos de lanzamiento de la AMI. | Matriz | No | ||
| atributos: lanzar Permission:userGroups | Los grupos de usuarios que se van a agregar o eliminar de los permisos de lanzamiento de la AMI. | Matriz | No | ||
| atributos: lanzar Permission:organizationArns | Los ARN de la AWS organización que se deben agregar o eliminar de los permisos de lanzamiento de la AMI. | Matriz | No | ||
| atributos: lanzar Permission:organizationalUnitArns | Los ARN de la unidad organizativa (OU) que se van a agregar o eliminar de los permisos de lanzamiento de la AMI. | Matriz | 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 |
| modificado Images:accountId | El ID de la cuenta de destino de la imagen distribuida. | Cadena |
| modificado Images:name | El nombre de la AMI. | Cadena |
| modificado Images:amiId | El ID de AMI de la imagen distribuida. | Cadena |
| modificado Images:dateStarted | Hora UTC en la que se inició la distribución. | Cadena |
| modificado Images:dateStopped | Hora UTC en la que se completó la distribución. | Cadena |
| modificado Images:step | El paso en el que se detuvo la distribución. | Finalizado| ModifyAmiRunning |
| modificado Images:region | La AWS región de la imagen. | Cadena |
| modificado Images:status | Estado de distribución. | Completado | Fallado | Cancelado | TimedOut |
| modificado Images:errorMessage | Mensaje de error, si lo hay. | Cadena |
Ejemplo
Especifique la acción de paso en el documento de flujos de trabajo.
- name:ModifyImageAttributesaction: ModifyImageAttributes onFailure: Abort inputs: distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages attributes: - region:us-west-2launchPermission: userIds: - "111122223333"
Utilice la salida del valor de la acción de paso en el documento de flujos de trabajo.
$.stepOutputs.ModifyImageAttributesStep.modifiedImages
RegisterImage
Este paso registra una nueva imagen de máquina de Amazon (AMI) mediante la RegisterImage API de Amazon EC2. Le permite crear una AMI a partir de una instantánea o un conjunto de instantáneas existente, especificando varios atributos de la imagen.
Tiempo de espera predeterminado: 540 minutos
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| arquitectura | La arquitectura de la AMI. | Cadena | No | Valores válidos: i386, x86_64, arm64, x86_64_mac, arm64_mac | |
| bloquear DeviceMapping | Bloquea las entradas de mapeo de dispositivos 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 | ||
| Soporte de ENA | Si la mejora de las redes con ENA está habilitada. | Booleano | No | ||
| Ubicación de la imagen | La ubicación del manifiesto de la AMI. | Cadena | No | Necesario para las S3-backed AMI | |
| Soporte para IMDS | El nivel de soporte de IMDSv2. | Cadena | No | Valores válidos: v2.0 | |
| incluir SnapshotTags | Si se deben incluir las etiquetas de la primera instantánea definida en el mapeo de dispositivos de bloques. | Booleano | No | FALSO |
Cuando se establece en true, las etiquetas se incluyen de la siguiente manera:
|
| ID de núcleo | El ID del núcleo que se va a utilizar. | Cadena | No | ||
| ID de disco RAM | El ID del disco RAM que se va a utilizar. | Cadena | No | ||
| raíz DeviceName | El nombre del dispositivo raíz. | Cadena | No | Ejemplo:/dev/sda1 | |
| sirov NetSupport | Redes mejoradas con la interfaz Intel 82599 VF. | Cadena | No | ||
| Soporte TPM | Soporte de la versión TPM. | Cadena | No | Valores válidos: v2.0 | |
| Datos de UEFI | Base64-encoded Datos UEFI. | 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 |
Se requieren permisos de IAM
Su rol de ejecución personalizado debe tener los siguientes permisos para usar esta acción escalonada:
Permitir acciones
-
ec2:DescribeSnapshots -
ec2:CreateTags
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 de otro paso e instantáneas 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-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
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: 720 minutos.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia en la que se va a ejecutar el documento de comandos. | Cadena | Sí | 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 | Sí | ||
| 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 |
|---|---|---|
| ejecutar CommandId | 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:RunCommandDocaction: RunCommand onFailure: Abort inputs: documentName:SampleDocumentparameters: 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.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia en la que se va a ejecutar el documento AWSEC2-RunSysprep. |
Cadena | Sí | 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 |
|---|---|---|
| ejecutar CommandId | 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:RunSysprepaction: 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.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia que se va a sanear. | Cadena | Sí | 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 |
|---|---|---|
| ejecutar CommandId | 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:SanitizeStepaction: 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 que especificó con la instanceId entrada. De forma predeterminada, inicia la terminación y pasa al siguiente paso sin esperar. Un proceso en segundo plano gestiona la limpieza si al finalizar se producen errores en el servicio de EC2. Para esperar a que finalice por completo antes de continuar, defina la waitForTermination entrada como. true
Tiempo de espera predeterminado: 30 minutos.
Tiempo de espera máximo: 720 minutos (12 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | ID de la instancia que se va a terminar. | Cadena | Sí | Ninguno | Ninguno |
| espera ForTermination | Especifica si el paso espera a que la instancia alcance el estado terminado antes de continuar. Si se establece entrue, el paso espera a que finalice por completo (de 10 segundos a varios minutos). |
Booleano | No | false |
true | false |
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:TerminateInstanceaction: TerminateInstance onFailure: Continue inputs: instanceId.$:i-1234567890abcdef0waitForTermination:false
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 tu bus de EventBridge eventos predeterminado con el 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.
Cómo funcionan la pausa y la reanudación
Cuando se ejecuta un WaitForAction paso, Image Builder establece el estado del paso WAITING y publica un EventBridge evento (tipo de detalleEC2 Image Builder Workflow Step Waiting). Si lo proporcionasnsTopicArn, también envía una notificación de Amazon SNS. Si la proporcionalambdaFunctionName, invoca esa función de forma asincrónica. El flujo de trabajo permanece en pausa hasta que ocurra una de las siguientes situaciones:
-
Llama SendWorkflowStepAction a
RESUMEpara continuar oSTOPfinalizar el flujo de trabajo. -
Se agota el tiempo de espera del paso (3 días por defecto, 7 días como máximo) y el flujo de trabajo falla.
El reason valor al que pases SendWorkflowStepAction se almacena con el paso y está disponible para los pasos posteriores como reason salida del paso.
Tiempo de espera predeterminado: 3 días.
Tiempo de espera máximo: 7 días (604,800 segundos)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| sns TopicArn | ARN de un tema de SNS opcional al que enviar una notificación cuando el paso del flujo de trabajo esté pendiente. | Cadena | No | ||
| lambda FunctionName | Un nombre o ARN opcional de la función de Lambda para invocarla de forma asincrónica 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 y se usa para SNS message/payload y Lambda, respectivamente. Si no se proporciona, genera el valor predeterminado. 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 |
Se requieren permisos de IAM
Su rol de ejecución personalizado debe tener los siguientes permisos para usar esta acción escalonada:
Permitir acciones
-
lambda:InvokeFunction
Especifique los recursos
-
arn:aws:lambda:us-west-2:111122223333:function:function-name -
arn:aws:lambda:us-west-2:111122223333:function:*
Ejemplo
Especifique la acción del paso en el documento de flujo de trabajo con la notificación de SNS.
- name:SendEventAndWaitaction: WaitForAction onFailure: Abort inputs: snsTopicArn: arn:aws:sns:us-west-2:111122223333:ExampleTopic
Especifique la acción escalonada en el documento de flujo de trabajo con la invocación de la función Lambda.
- name:SendEventAndWaitWithLambdaaction: WaitForAction onFailure: Abort inputs: lambdaFunctionName:ExampleFunctionpayload: | { "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 instancia de EC2 sea administrable una AWS Systems Manager vez transcurridos 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 monitorea la instancia hasta que recupere la conectividad SSM o agote el tiempo de espera.
Tiempo de espera predeterminado: 60 minutos.
Tiempo de espera máximo: 180 minutos (3 horas)
Puede anular el valor predeterminado con timeoutSeconds uno hasta el máximo que se muestra. Un valor superior al máximo no se valida.
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 | Restricciones |
|---|---|---|---|---|---|
| instanceId | El ID de la instancia para supervisar la conectividad del SSM. | Cadena | Sí | Debe ser un ID de instancia EC2 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:WaitForInstanceAfterRebootaction: WaitForSSMAgent onFailure: Abort timeoutSeconds: 900 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