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 d'étapes prises en charge pour votre document de flux de travail

Cette section contient des informations détaillées sur les actions d'étape prises en charge par Image Builder.

ApplyImageConfigurations

Cette étape applique diverses configurations et intégrations au système distribué AMIs, telles que les configurations de licence, les configurations de modèles de lancement, les configurations d'exportation S3, les configurations EC2 Fast Launch 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'expiration par défaut : 360 minutes

Durée maximale : 720 minutes

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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: ApplyImageConfigurations
  action: ApplyImageConfigurations
  onFailure: Abort
  inputs:
    distributedImages.$: $.stepOutputs.DistributeImageStep.distributedImages

Utilisez le résultat 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 les exigences minimales requises pour exécuter des flux de travail de conteneurs. Image Builder utilise sendCommand l'API de Systems Manager pour exécuter ce script. Pour plus d'informations, consultez la section AWS Systems Manager Exécuter la commande.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat 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 génération.

EC2 Image Builder exécute l'agent AWS Systems Manager (Systems Manager) sur les EC2 instances 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 construction 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 de leurs versions respectives tels qu'indiqués par votre système d'exploitation.

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

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

Entrées : Le tableau suivant inclut 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 génération.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat 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' EC2 CreateImageAPI Amazon. Pendant le processus de création, l'action de l'étape attend autant que nécessaire pour vérifier que les ressources ont atteint le bon état avant de continuer.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.CreateImageFromInstance.imageId

DistributeImage

Cette étape permet de distribuer une AMI à des régions et à des comptes spécifiques. Il crée des copies de l'AMI dans les régions et les comptes cibles en fonction de la configuration de distribution fournie dans les demandes CreateImage CreateImagePipeline APIs ou des paramètres de distribution personnalisés fournis dans le flux de travail pour remplacer les paramètres de la configuration de distribution.

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

Durée maximale : 720 minutes

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.DistributeImageStep.distributedImages

ExecuteComponents

Cette étape exécute les composants spécifiés dans la recette de 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 les composants de test sur l'instance de test.

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

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 é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, consultez la section « En savoir plus sur les machines à états » dans Step Functions du manuel du AWS Step Functions développeur.

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

Délai d'attente maximal : 24 heures

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.ValidateImageCompliance.executionArn

LaunchInstance

Cette action lance une instance dans votre instance Compte AWS et attend que l'agent Systems Manager soit exécuté sur l'instance avant de passer à l'étape suivante. L'action de lancement utilise les paramètres de votre recette et les ressources de configuration de l'infrastructure associées à votre image. Par exemple, le type d'instance à lancer provient de la configuration de l'infrastructure. Le résultat est l'ID d'instance de l'instance qu'il a lancée.

L'waitForentrée configure la condition qui satisfait à l'exigence d'achèvement de l'étape.

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

Annulation : pour les instances de build, la restauration exécute l'action que vous avez configurée dans votre ressource de configuration d'infrastructure. Par défaut, les instances de build sont arrêtées en cas d'échec de la création de l'image. Cependant, la configuration de l'infrastructure comporte un paramètre permettant de conserver l'instance de build à des fins de dépannage.

Entrées : Le tableau suivant inclut 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:
    waitFor: ssmAgent

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

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

Cette action d'étape modifie les attributs de distributed AMIs, tels que les autorisations de lancement et les autres attributs de l'AMI. Il fonctionne sur la AMIs base de ceux qui ont été distribués aux régions et aux comptes cibles.

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

Durée maximale : 180 minutes

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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

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

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

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

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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: 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.RegisterNewImage.imageId

Exemple avec un SnapshotId extrait d'une autre étape et des balises de capture d'écran 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, consultez la section AWS Systems Manager Exécuter la commande.

Délai d'expiration par défaut : 12 heures

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.RunCommandDoc.status

RunSysPrep

Cette action utilise l'API sendCommand in the Systems Manager pour exécuter le AWSEC2-RunSysprep document pour les instances Windows avant que l'instance de build ne s'arrête pour le snapshot. Ces actions suivent les AWS meilleures pratiques en matière de renforcement et de nettoyage de l'image.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat 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 que l'instance de build ne s'arrête pour le snapshot. Le script de désinfection permet de garantir que l'image finale respecte les meilleures pratiques de sécurité et que les artefacts ou paramètres de build qui ne devraient pas être répercutés sur votre instantané sont supprimés. Pour plus d'informations sur le script, consultezNettoyage requis après la construction. Cette action de cette étape ne s'applique pas aux images du conteneur.

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

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 le résultat de la valeur de l'action de l'étape dans le document de flux de travail.

$.stepOutputs.SanitizeStep.status

TerminateInstance

Cette étape met fin à l'instance avec l'identifiant d'instance transmis en entrée.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut les entrées prises en charge pour cette action d'étape.

Sorties : Il n'y a aucune sortie 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

WaitForAction

Cette étape interrompt le flux de travail en cours d'exécution et attend de recevoir une action externe de la part de l'action d'SendWorkflowStepActionAPI Image Builder. Cette étape publie un EventBridge événement sur 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.

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

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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 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 avec l'invocation de la fonction Lambda.

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

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

$.stepOutputs.SendEventAndWait.reason

WaitForSSMAgent

Cette action d'étape attend qu'une EC2 instance devienne gérable AWS Systems Manager après les périodes attendues d'absence de réponse. Cela est particulièrement utile pour les flux de travail présentant des interruptions d'instance connues, tels 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 sa connectivité SSM ou qu'elle expire.

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

Durée maximale : 180 minutes

Annulation : il n'y a aucune annulation pour cette action d'étape.

Entrées : Le tableau suivant inclut 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
  timeoutInSeconds: 900 # 15 minutes
  inputs:
    instanceId.$: $.stepOutputs.LaunchStep.instanceId

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

$.stepOutputs.WaitForInstanceAfterReboot.Status