As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Ações de etapa compatíveis com seu documento de fluxo de trabalho

Esta seção inclui detalhes das ações de etapa compatíveis com o Image Builder.

ApplyImageConfigurations

Essa ação de etapa aplica várias configurações e integrações distribuídas AMIs, como configurações de licença, configurações de modelo de lançamento, configurações de exportação do S3, configurações do EC2 Fast Launch e configurações de parâmetros do Systems Manager. As configurações se aplicam a imagens distribuídas somente na conta de origem, exceto às configurações de parâmetros SSM, que podem ser aplicadas entre contas.

Tempo limite padrão: 360 minutos

Tempo limite máximo: 720 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.ApplyImageConfigurationsStep.configuredImages

BootstrapInstanceForContainer

Essa ação de etapa executa um script de serviço para fazer o bootstrap da instância com requisitos mínimos para executar fluxos de trabalho de contêiner. O Image Builder usa o sendCommand na API do Systems Manager para executar esse script. Para obter mais informações, consulte Comando Run do AWS Systems Manager.

Tempo limite padrão: 60 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.ContainerBootstrapStep.status

CollectImageMetadata

Essa ação de etapa só é válida para fluxos de trabalho de compilação.

EC2 O Image Builder executa o Agente AWS Systems Manager (Systems Manager) nas EC2 instâncias que ele executa para criar e testar sua imagem. O Image Builder coleta informações adicionais sobre a instância usada durante a fase de compilação com o Systems Manager Inventory. Essas informações incluem o nome e a versão do sistema operacional (SO), bem como a lista de pacotes e suas respectivas versões, conforme relatado pelo seu sistema operacional.

Tempo limite padrão: 30 minutos

Reversão: o Image Builder reverte todos os recursos do Systems Manager que foram criados durante essa etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.CollectMetadataStep.osVersion

CollectImageScanFindings

Se o Amazon Inspector estiver habilitado para sua conta e a digitalização de imagens estiver habilitada para seu pipeline, essa ação de etapa coletará descobertas de digitalização de imagens relatadas pelo Amazon Inspector para sua instância de teste. Essa ação de etapa não está disponível para fluxos de trabalho de compilação.

Tempo limite padrão: 120 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.CollectFindingsStep.status

CreateImage

Essa ação de etapa cria uma imagem de uma instância em execução com a EC2 CreateImage API da Amazon. Durante o processo de criação, antes prosseguir, a ação de etapa aguarda conforme necessário para verificar se os recursos alcançaram o estado correto.

Tempo limite padrão: 720 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.CreateImageFromInstance.imageId

DistributeImage

Essa ação de etapa distribui uma AMI para regiões e contas especificadas. Ele cria cópias da AMI nas regiões e contas de destino com base na configuração de distribuição fornecida nas solicitações de CreateImage ou CreateImagePipeline APIs ou nas configurações de distribuição personalizadas fornecidas no fluxo de trabalho para substituir as configurações na configuração de distribuição.

Tempo limite padrão: 360 minutos

Tempo limite máximo: 720 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.DistributeImageStep.distributedImages

ExecuteComponents

Essa ação de etapa executa componentes especificados na fórmula da imagem atual que está sendo criada. Fluxos de trabalho de compilação executam componentes de compilação na instância de compilação. Os fluxos de trabalho de teste executam somente componentes de teste na instância de teste.

O Image Builder usa o sendCommand na API do Systems Manager para executar esse componentes. Para obter mais informações, consulte Comando Run do AWS Systems Manager.

Tempo limite padrão: 720 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.ExecComponentsStep.status

ExecuteStateMachine

Essa ação de etapa inicia a execução de uma máquina de AWS Step Functions estado a partir de um fluxo de trabalho do Image Builder. O Image Builder usa a StartExecution API Step Functions para iniciar a máquina de estado e esperar que ela seja concluída. Isso é útil para integrar fluxos de trabalho complexos, validação de conformidade ou processos de certificação em seu pipeline de criação de imagens.

Para obter mais informações, consulte Saiba mais sobre máquinas de estado em Step Functions no AWS Step Functions Developer Guide.

Tempo limite padrão: 6 horas

Tempo limite máximo: 24 horas

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Permissões do IAM necessárias

Sua função de execução personalizada deve ter as seguintes permissões para usar essa ação de etapa:

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.ValidateImageCompliance.executionArn

LaunchInstance

Essa ação de etapa inicia uma instância na sua Conta da AWS e espera até que o agente do Systems Manager esteja em execução na instância antes de passar para a próxima etapa. A ação de inicialização usa configurações de sua fórmula e recursos de configuração de infraestrutura associados à sua imagem. Por exemplo, o tipo de instância a ser executada vem da configuração da infraestrutura. A saída é o ID da instância que foi executada.

A entrada waitFor configura a condição que satisfaz o requisito de conclusão da etapa.

Tempo limite padrão: 60 minutos

Reversão: para instâncias de construção, a reversão executa a ação que você configurou em seu recurso de configuração de infraestrutura. Por padrão, as instâncias de compilação são encerradas se a criação da imagem falhar. No entanto, há uma definição na configuração da infraestrutura para manter a instância de compilação para solução de problemas.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.LaunchStep.instanceId

ModifyImageAttributes

Essa ação de etapa modifica atributos distribuídos AMIs, como permissões de execução e outros atributos da AMI. Ele opera com base nas AMIs que foram distribuídas para regiões e contas alvo.

Tempo limite padrão: 120 minutos

Tempo limite máximo: 180 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.ModifyImageAttributesStep.modifiedImages

RegisterImage

Essa ação de etapa registra uma nova Amazon Machine Image (AMI) usando a EC2 RegisterImage API da Amazon. Ele permite que você crie uma AMI a partir de um snapshot existente ou de um conjunto de snapshots, especificando vários atributos de imagem.

Tempo limite padrão: 720 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.RegisterNewImage.imageId

Exemplo com uma SnapshotId de outra etapa e tags de snapshot incluídas na AMI gerada

- 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

Essa ação de etapa executa um documento de comando para seu fluxo de trabalho. O Image Builder usa o sendCommand na API do Systems Manager para executá-lo em seu nome. Para obter mais informações, consulte Comando Run do AWS Systems Manager.

Tempo limite padrão: 12 horas

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.RunCommandDoc.status

RunSysPrep

Essa ação de etapa usa o sendCommand na API do Systems Manager para executar o documento AWSEC2-RunSysprep para instâncias do Windows antes que a instância de compilação seja encerrada para o snapshot. Essas ações seguem as AWS melhores práticas para endurecer e limpar a imagem.

Tempo limite padrão: 60 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.RunSysprep.status

SanitizeInstance

Essa ação de etapa executa o script de limpeza recomendado para instâncias Linux antes que a instância de compilação seja encerrada para o snapshot. O script de limpeza ajuda a garantir que a imagem final siga as práticas recomendadas de segurança e a remoção de qualquer artefato ou configuração de compilação que não deva ser transferida para seu snapshot. Para obter mais informações sobre o script, consulte Limpeza necessária após a construção. Essa ação não se aplica a imagens de contêiner.

O Image Builder usa o sendCommand na API do Systems Manager para executar esse script. Para obter mais informações, consulte Comando Run do AWS Systems Manager.

Tempo limite padrão: 60 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.SanitizeStep.status

TerminateInstance

Essa ação de etapa encerra a instância com o ID da instância que é transmitido como entrada.

Tempo limite padrão: 30 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: não há saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

WaitForAction

Essa ação de etapa pausa o fluxo de trabalho em execução e aguarda o recebimento de uma ação externa da ação SendWorkflowStepAction da API do Image Builder. Esta etapa publica um EventBridge evento em seu ônibus de EventBridge eventos padrão com o tipo de EC2 Image Builder Workflow Step Waiting detalhe. A etapa também pode enviar uma notificação do SNS se você fornecer um ARN de tópico do SNS ou invocar uma função do Lambda de forma assíncrona se você fornecer um nome de função do Lambda.

Tempo limite padrão: 3 dias

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação da etapa no documento do fluxo de trabalho com a notificação do SNS.

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

Especifique a ação da etapa no documento do fluxo de trabalho com a invocação da função Lambda.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.SendEventAndWait.reason

WaitForSSMAgent

Essa ação de etapa espera que uma EC2 instância se torne gerenciável AWS Systems Manager após os períodos esperados de falta de resposta. É particularmente importante para fluxos de trabalho com interrupções de instância conhecidas, como reinicializações do sistema, atualizações do sistema operacional ou operações específicas da plataforma que desconectam temporariamente a instância do SSM. O Image Builder monitora a instância até que ela recupere a conectividade SSM ou atinja o tempo limite.

Tempo limite padrão: 60 minutos

Tempo limite máximo: 180 minutos

Reversão: não há reversão para essa ação de etapa.

Entradas: a tabela a seguir inclui entradas compatíveis com essa ação de etapa.

Saídas: a tabela a seguir inclui saídas para essa ação de etapa.

Exemplo

Especifique a ação de etapa no documento de fluxo de trabalho.

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

Use a saída do valor da ação da etapa no documento do fluxo de trabalho.

$.stepOutputs.WaitForInstanceAfterReboot.Status