2.232.2

enum WorkflowAction 🔹

LanguageType name
.NETAmazon.CDK.AWS.ImageBuilder.Alpha.WorkflowAction
Gogithub.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#WorkflowAction
Javasoftware.amazon.awscdk.services.imagebuilder.alpha.WorkflowAction
Pythonaws_cdk.aws_imagebuilder_alpha.WorkflowAction
TypeScript (source)@aws-cdk/aws-imagebuilder-alpha » WorkflowAction

The action for a step within the workflow document.

Example

const workflow = new imagebuilder.Workflow(this, 'MyWorkflow', {
  workflowType: imagebuilder.WorkflowType.BUILD,
  data: imagebuilder.WorkflowData.fromJsonObject({
    schemaVersion: imagebuilder.WorkflowSchemaVersion.V1_0,
    steps: [
      {
        name: 'LaunchBuildInstance',
        action: imagebuilder.WorkflowAction.LAUNCH_INSTANCE,
        onFailure: imagebuilder.WorkflowOnFailure.ABORT,
        inputs: {
          waitFor: 'ssmAgent',
        },
      },
      {
        name: 'ExecuteComponents',
        action: imagebuilder.WorkflowAction.EXECUTE_COMPONENTS,
        onFailure: imagebuilder.WorkflowOnFailure.ABORT,
        inputs: {
          'instanceId': 'i-123',
        },
      },
      {
        name: 'CreateImage',
        action: imagebuilder.WorkflowAction.CREATE_IMAGE,
        onFailure: imagebuilder.WorkflowOnFailure.ABORT,
        inputs: {
          'instanceId': 'i-123',
        },
      },
      {
        name: 'TerminateInstance',
        action: imagebuilder.WorkflowAction.TERMINATE_INSTANCE,
        onFailure: imagebuilder.WorkflowOnFailure.CONTINUE,
        inputs: {
          'instanceId': 'i-123',
        },
      },
    ],
    outputs: [
      {
        name: 'ImageId',
        value: '$.stepOutputs.CreateImage.imageId',
      },
    ],
  }),
});

Members

NameDescription
APPLY_IMAGE_CONFIGURATIONS 🔹Applies customizations and configurations to the input AMIs, such as publishing the AMI to SSM Parameter Store, or creating launch template versions with the AMI IDs provided in the input.
BOOTSTRAP_INSTANCE_FOR_CONTAINER 🔹The BootstrapInstanceForContainer action runs a service script to bootstrap the instance with minimum requirements to run container workflows.
COLLECT_IMAGE_METADATA 🔹The CollectImageMetadata action collects additional information about the instance, such as the list of packages and their respective versions.
COLLECT_IMAGE_SCAN_FINDINGS 🔹The CollectImageScanFindings action collects findings reported by Amazon Inspector for the provided instance.
CREATE_IMAGE 🔹The CreateImage action creates an AMI from a running instance with the ec2:CreateImage API.
DISTRIBUTE_IMAGE 🔹The DistributeImage action copies an AMI using the image's distribution configuration, or using the distribution settings in the step input.
EXECUTE_COMPONENTS 🔹The ExecuteComponents action runs components that are specified in the recipe for the current image being built.
EXECUTE_STATE_MACHINE 🔹The ExecuteStateMachine action executes a the state machine provided and waits for completion as part of the workflow.
LAUNCH_INSTANCE 🔹The LaunchInstance action launches an instance using the settings from your recipe and infrastructure configuration resources.
MODIFY_IMAGE_ATTRIBUTES 🔹Applies attribute updates to the provided set of distributed images, such as launch permission updates.
RUN_COMMAND 🔹The RunCommand action runs a command document against the provided instance.
REGISTER_IMAGE 🔹The RegisterImage action creates an AMI from a set of snapshots with the ec2:RegisterImage API.
RUN_SYS_PREP 🔹The RunSysprep action runs the Sysprep document on the provided Windows instance.
SANITIZE_INSTANCE 🔹The SanitizeInstance action runs a recommended sanitization script on Linux instances.
TERMINATE_INSTANCE 🔹The TerminateInstance action terminates the provided instance.
WAIT_FOR_ACTION 🔹The WaitForAction action pauses the workflow and waits to receive an external signal from the imagebuilder:SendWorkflowStepAction API.
WAIT_FOR_SSM_AGENT 🔹The WaitForSSMAgent action waits for the given instance to have connectivity with SSM before proceeding.

APPLY_IMAGE_CONFIGURATIONS 🔹

Applies customizations and configurations to the input AMIs, such as publishing the AMI to SSM Parameter Store, or creating launch template versions with the AMI IDs provided in the input.

BOOTSTRAP_INSTANCE_FOR_CONTAINER 🔹

The BootstrapInstanceForContainer action runs a service script to bootstrap the instance with minimum requirements to run container workflows.

COLLECT_IMAGE_METADATA 🔹

The CollectImageMetadata action collects additional information about the instance, such as the list of packages and their respective versions.

COLLECT_IMAGE_SCAN_FINDINGS 🔹

The CollectImageScanFindings action collects findings reported by Amazon Inspector for the provided instance.

CREATE_IMAGE 🔹

The CreateImage action creates an AMI from a running instance with the ec2:CreateImage API.

DISTRIBUTE_IMAGE 🔹

The DistributeImage action copies an AMI using the image's distribution configuration, or using the distribution settings in the step input.

EXECUTE_COMPONENTS 🔹

The ExecuteComponents action runs components that are specified in the recipe for the current image being built.

EXECUTE_STATE_MACHINE 🔹

The ExecuteStateMachine action executes a the state machine provided and waits for completion as part of the workflow.

LAUNCH_INSTANCE 🔹

The LaunchInstance action launches an instance using the settings from your recipe and infrastructure configuration resources.

MODIFY_IMAGE_ATTRIBUTES 🔹

Applies attribute updates to the provided set of distributed images, such as launch permission updates.

RUN_COMMAND 🔹

The RunCommand action runs a command document against the provided instance.

REGISTER_IMAGE 🔹

The RegisterImage action creates an AMI from a set of snapshots with the ec2:RegisterImage API.

RUN_SYS_PREP 🔹

The RunSysprep action runs the Sysprep document on the provided Windows instance.

SANITIZE_INSTANCE 🔹

The SanitizeInstance action runs a recommended sanitization script on Linux instances.

TERMINATE_INSTANCE 🔹

The TerminateInstance action terminates the provided instance.

WAIT_FOR_ACTION 🔹

The WaitForAction action pauses the workflow and waits to receive an external signal from the imagebuilder:SendWorkflowStepAction API.

WAIT_FOR_SSM_AGENT 🔹

The WaitForSSMAgent action waits for the given instance to have connectivity with SSM before proceeding.

← PreviousNext →