Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Actions par étapes prises en charge pour votre document de flux de travail

Cette section détaille les actions par étapes prises en charge par Image Builder.

Le tableau suivant indique quelles étapes du flux de travail prennent en charge chaque action d'étape. Une coche (X) indique que vous pouvez utiliser l'action de l'étape à cette étape. Image Builder limite certaines actions à des étapes spécifiques : ExecuteComponents aux étapes de création et de test, CollectImageScanFindings à la phase de test DistributeImage ModifyImageAttributesApplyImageConfigurations, et DistributeContainerImage à la phase de distribution. Vous pouvez utiliser toutes les autres actions à n'importe quel stade.

ApplyImageConfigurations

Utilisez cette étape pour appliquer diverses configurations et intégrations aux AMI distribuées, telles que les configurations de licence, les configurations de modèles de lancement, les configurations d'exportation S3, les configurations de lancement rapide EC2 et les configurations de paramètres de Systems Manager. Les configurations s'appliquent aux images distribuées uniquement dans le compte source, à l'exception des configurations de paramètres SSM qui peuvent être appliquées entre comptes.

Délai d'attente par défaut : 360 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure à la valeur maximale échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape. La distributedImages.$ saisie est obligatoire. Les lignes restantes décrivent les champs de chaque élément du configurations tableau.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

Cette action d'étape exécute un script de service pour démarrer l'instance avec la configuration minimale requise pour exécuter des flux de travail de conteneur. Image Builder utilise sendCommand l'API Systems Manager pour exécuter ce script. Pour plus d'informations, voir AWS Systems Manager Exécuter la commande.

Délai d'attente par défaut : 60 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

Cette action d'étape n'est valide que pour les flux de travail de création.

EC2 Image Builder exécute l'agent AWS Systems Manager (Systems Manager) sur les instances EC2 qu'il lance pour créer et tester votre image. Image Builder collecte des informations supplémentaires sur l'instance utilisée pendant la phase de génération avec Systems Manager Inventory. Ces informations incluent le nom et la version du système d'exploitation (OS), ainsi que la liste des packages et leurs versions respectives, telles que signalées par votre système d'exploitation.

Délai d'attente par défaut : 30 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : Image Builder annule toutes les ressources Systems Manager créées au cours de cette étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez le résultat de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.CollectMetadataStep.osVersion

CollectImageScanFindings

Si Amazon Inspector est activé pour votre compte et que la numérisation d'images est activée pour votre pipeline, cette étape collecte les résultats de numérisation d'images signalés par Amazon Inspector pour votre instance de test. Cette action d'étape n'est pas disponible pour les flux de travail de création.

Délai d'attente par défaut : 120 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.CollectFindingsStep.status

CreateImage

Cette étape crée une image à partir d'une instance en cours d'exécution avec l'CreateImageAPI Amazon EC2. Pendant le processus de création, l'étape d'action attend si nécessaire pour vérifier que les ressources ont atteint l'état correct avant de continuer.

Délai d'attente par défaut : 720 minutes

Délai maximum : 3 jours (259 200 secondes)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure à la valeur maximale échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.CreateImageFromInstance.imageId

CreateImageFromIso

Utilisez cette action pour créer une Amazon Machine Image (AMI) à partir d'une image disque ISO sur l'instance de génération. Utilisez-le dans un flux de création lorsque votre source est un fichier ISO plutôt qu'une AMI de base. Image Builder convertit l'ISO en AMI et attend que les ressources atteignent l'état requis avant de continuer.

Délai d'attente par défaut : 720 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure à la valeur maximale échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.CreateImageFromIsoStep.amiName

DistributeContainerImage

Utilisez cette action pour distribuer une image de conteneur créée par l'étape de création dans les référentiels Amazon ECR dans les régions cibles définies pour l'image. Utilisez cette action dans un flux de distribution pour les images de conteneur (DOCKER). Il fonctionne comme l'équivalent de l'image de conteneur de. DistributeImage

Cette étape exécute une commande Systems Manager sur l'instance de génération pour envoyer l'image du conteneur. Docker doit être AWS CLI installé sur l'instance. Pour de plus amples informations, veuillez consulter BootstrapInstanceForContainer.

Délai d'attente par défaut : 120 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure à la valeur maximale échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.DistributeContainer.status

DistributeImage

Cette étape distribue une AMI aux régions et comptes cibles que vous spécifiez. Il utilise la configuration de distribution que vous avez CreateImage CreateImagePipeline demandée ou des paramètres de distribution personnalisés dans le flux de travail qui remplacent la configuration par défaut.

Délai d'attente par défaut : 360 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure à la valeur maximale échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.DistributeImageStep.distributedImages

ExecuteComponents

Cette action d'étape exécute les composants spécifiés dans la recette pour l'image en cours de création. Les flux de travail de génération exécutent les composants de génération sur l'instance de génération. Les flux de travail de test exécutent uniquement des composants de test sur l'instance de test.

Image Builder utilise sendCommand l'API Systems Manager pour exécuter les composants. Pour plus d'informations, voir AWS Systems Manager Exécuter la commande.

Délai d'attente par défaut : 720 minutes

Délai d'attente maximum : 1 jour (24 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez le résultat de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

Cette action d'étape lance l'exécution d'une machine à AWS Step Functions états à partir d'un flux de travail Image Builder. Image Builder utilise l'StartExecutionAPI Step Functions pour lancer la machine à états et attend qu'elle soit terminée. Cela est utile pour intégrer des flux de travail complexes, des processus de validation de conformité ou de certification dans votre pipeline de création d'images.

Pour plus d'informations, voir En savoir plus sur les machines à états dans Step Functions du Guide du AWS Step Functions développeur.

Délai d'attente par défaut : 6 heures

Délai d'attente maximum : 24 heures

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Autorisations IAM requises

Votre rôle d'exécution personnalisé doit disposer des autorisations suivantes pour utiliser cette action d'étape :

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ValidateImageCompliance.executionArn

LaunchInstance

Utilisez cette action pour lancer une instance dans votre Compte AWS. L'action attend que l'instance réponde à la condition de contrôle de santé spécifiée et que l'agent Systems Manager soit en cours d'exécution avant de passer à l'étape suivante. L'action de lancement utilise les paramètres de votre recette et des ressources de configuration de l'infrastructure. Par exemple, le type d'instance à lancer provient de la configuration de l'infrastructure. La sortie est l'ID de l'instance qui a été lancée.

L'waitForentrée configure la condition qui satisfait à l'exigence d'achèvement de l'étape. L'healthCheckentrée spécifie le niveau de validation de l'état de santé de l'instance EC2 qui doit réussir avant que l'étape ne se poursuive.

Délai d'attente par défaut : 75 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : pour les instances de build, la restauration exécute l'action que vous avez configurée dans la ressource de configuration de votre infrastructure. Par défaut, les instances de génération sont interrompues en cas d'échec de la création de l'image. Cependant, il existe un paramètre dans la configuration de l'infrastructure pour conserver l'instance de compilation à des fins de dépannage.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez le résultat de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

Utilisez cette action pour modifier les attributs des AMI distribuées, tels que les autorisations de lancement et d'autres attributs d'AMI. Il fonctionne sur des AMI qui ont été distribuées aux régions et aux comptes cibles.

Délai d'attente par défaut : 120 minutes

Délai maximum : 180 minutes (3 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

Cette étape enregistre une nouvelle Amazon Machine Image (AMI) à l'aide de l' RegisterImage API Amazon EC2. Il vous permet de créer une AMI à partir d'un instantané ou d'un ensemble d'instantanés existant, en spécifiant divers attributs d'image.

Délai d'attente par défaut : 540 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Autorisations IAM requises

Votre rôle d'exécution personnalisé doit disposer des autorisations suivantes pour utiliser cette action d'étape :

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.RegisterNewImage.imageId

Exemple avec une étape SnapshotId issue d'une autre étape et des balises de capture instantanée incluses dans l'AMI générée

- 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

Cette étape exécute un document de commande pour votre flux de travail. Image Builder utilise sendCommand l'API de Systems Manager pour l'exécuter pour vous. Pour plus d'informations, voir AWS Systems Manager Exécuter la commande.

Délai d'attente par défaut : 720 minutes

Délai maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.RunCommandDoc.status

RunSysPrep

Cette étape utilise l'sendCommandAPI Systems Manager pour exécuter le AWSEC2-RunSysprep document pour les instances Windows avant que l'instance de génération ne s'arrête pour la capture d'écran. Ces actions suivent les AWS meilleures pratiques en matière de durcissement et de nettoyage de l'image .

Délai d'attente par défaut : 60 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.RunSysprep.status

SanitizeInstance

Cette étape exécute le script de nettoyage recommandé pour les instances Linux avant l'arrêt de l'instance de génération pour le snapshot. Le script de nettoyage permet de s'assurer que l'image finale respecte les meilleures pratiques de sécurité et que les artefacts de création ou les paramètres qui ne devraient pas être transférés sur votre instantané sont supprimés. Pour plus d'informations sur le script, consultezNettoyage requis après la construction. Cette action d'étape ne s'applique pas aux images de conteneurs.

Image Builder utilise sendCommand l'API Systems Manager pour exécuter ce script. Pour plus d'informations, voir AWS Systems Manager Exécuter la commande.

Délai d'attente par défaut : 60 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.SanitizeStep.status

TerminateInstance

Cette action met fin à l'instance que vous spécifiez avec l'instanceIdentrée. Par défaut, il déclenche la résiliation et passe à l'étape suivante sans attendre. Un processus d'arrière-plan gère le nettoyage si la terminaison rencontre des erreurs de service EC2. Pour attendre la fin complète avant de continuer, réglez l'waitForTerminationentrée surtrue.

Délai d'attente par défaut : 30 minutes

Délai d'attente maximum : 720 minutes (12 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : aucune sortie n'est disponible pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

WaitForAction

Cette étape interrompt le flux de travail en cours et attend de recevoir une action externe de l'action de l'SendWorkflowStepActionAPI Image Builder. Cette étape publie un EventBridge événement dans votre bus d' EventBridge événements par défaut avec un type de détailEC2 Image Builder Workflow Step Waiting. L'étape peut également envoyer une notification SNS si vous fournissez un ARN de rubrique SNS, ou invoquer une fonction Lambda de manière asynchrone si vous fournissez un nom de fonction Lambda.

Fonctionnement de la pause et de la reprise

Lorsqu'une WaitForAction étape est exécutée, Image Builder définit le statut de l'étape sur WAITING et publie un EventBridge événement (type de détailEC2 Image Builder Workflow Step Waiting). Si vous le fournissezsnsTopicArn, il envoie également une notification Amazon SNS. Si vous fournissezlambdaFunctionName, il invoque cette fonction de manière asynchrone. Le flux de travail reste suspendu jusqu'à ce que l'une des situations suivantes se produise :

Le reason message que vous passez SendWorkflowStepAction est enregistré avec l'étape et est disponible pour les étapes suivantes en tant que reason résultat de l'étape.

Délai d'attente par défaut : 3 jours

Délai d'attente maximum : 7 jours (604 800 secondes)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Autorisations IAM requises

Votre rôle d'exécution personnalisé doit disposer des autorisations suivantes pour utiliser cette action d'étape :

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail avec notification SNS.

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

Spécifiez l'action de l'étape dans le document de flux de travail en invoquant la fonction Lambda.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.SendEventAndWait.reason

WaitForSSMAgent

Cette étape attend qu'une instance EC2 devienne gérable AWS Systems Manager après les périodes d'absence de réponse prévues. Il est particulièrement utile pour les flux de travail présentant des interruptions d'instance connues, telles que les redémarrages du système, les mises à niveau du système d'exploitation ou les opérations spécifiques à la plate-forme qui déconnectent temporairement l'instance de SSM. Image Builder surveille l'instance jusqu'à ce qu'elle retrouve la connectivité SSM ou qu'elle expire.

Délai d'attente par défaut : 60 minutes

Délai d'attente maximum : 180 minutes (3 heures)

Vous pouvez remplacer la valeur par défaut partimeoutSeconds, jusqu'à la valeur maximale affichée. Une valeur supérieure au maximum échoue à la validation.

Annulation : aucune annulation n'est possible pour cette action d'étape.

Entrées : le tableau suivant répertorie les entrées prises en charge pour cette action d'étape.

Sorties : le tableau suivant inclut les sorties pour cette action d'étape.

Exemple

Spécifiez l'action de l'étape dans le document de flux de travail.

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

Utilisez la sortie de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.WaitForInstanceAfterReboot.status