Package software.amazon.awscdk.services.imagebuilder.alpha

Enum WorkflowAction

java.lang.Object
java.lang.Enum<WorkflowAction>
software.amazon.awscdk.services.imagebuilder.alpha.WorkflowAction
All Implemented Interfaces:
Serializable, Comparable<WorkflowAction>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:27.261Z") @Stability(Experimental) public enum WorkflowAction extends Enum<WorkflowAction>
(experimental) The action for a step within the workflow document.

Example: 

 Workflow workflow = Workflow.Builder.create(this, "MyWorkflow")
         .workflowType(WorkflowType.BUILD)
         .data(WorkflowData.fromJsonObject(Map.of(
                 "schemaVersion", WorkflowSchemaVersion.V1_0,
                 "steps", List.of(Map.of(
                         "name", "LaunchBuildInstance",
                         "action", WorkflowAction.LAUNCH_INSTANCE,
                         "onFailure", WorkflowOnFailure.ABORT,
                         "inputs", Map.of(
                                 "waitFor", "ssmAgent")), Map.of(
                         "name", "ExecuteComponents",
                         "action", WorkflowAction.EXECUTE_COMPONENTS,
                         "onFailure", WorkflowOnFailure.ABORT,
                         "inputs", Map.of(
                                 "instanceId", "i-123")), Map.of(
                         "name", "CreateImage",
                         "action", WorkflowAction.CREATE_IMAGE,
                         "onFailure", WorkflowOnFailure.ABORT,
                         "inputs", Map.of(
                                 "instanceId", "i-123")), Map.of(
                         "name", "TerminateInstance",
                         "action", WorkflowAction.TERMINATE_INSTANCE,
                         "onFailure", WorkflowOnFailure.CONTINUE,
                         "inputs", Map.of(
                                 "instanceId", "i-123"))),
                 "outputs", List.of(Map.of(
                         "name", "ImageId",
                         "value", "$.stepOutputs.CreateImage.imageId")))))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static WorkflowAction
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static WorkflowAction[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • APPLY_IMAGE_CONFIGURATIONS

      @Stability(Experimental) public static final WorkflowAction APPLY_IMAGE_CONFIGURATIONS
      (experimental) 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

      @Stability(Experimental) public static final WorkflowAction BOOTSTRAP_INSTANCE_FOR_CONTAINER
      (experimental) The BootstrapInstanceForContainer action runs a service script to bootstrap the instance with minimum requirements to run container workflows.

    • COLLECT_IMAGE_METADATA

      @Stability(Experimental) public static final WorkflowAction COLLECT_IMAGE_METADATA
      (experimental) The CollectImageMetadata action collects additional information about the instance, such as the list of packages and their respective versions.

    • COLLECT_IMAGE_SCAN_FINDINGS

      @Stability(Experimental) public static final WorkflowAction COLLECT_IMAGE_SCAN_FINDINGS
      (experimental) The CollectImageScanFindings action collects findings reported by Amazon Inspector for the provided instance.

    • CREATE_IMAGE

      @Stability(Experimental) public static final WorkflowAction CREATE_IMAGE
      (experimental) The CreateImage action creates an AMI from a running instance with the ec2:CreateImage API.

    • DISTRIBUTE_IMAGE

      @Stability(Experimental) public static final WorkflowAction DISTRIBUTE_IMAGE
      (experimental) The DistributeImage action copies an AMI using the image's distribution configuration, or using the distribution settings in the step input.

    • EXECUTE_COMPONENTS

      @Stability(Experimental) public static final WorkflowAction EXECUTE_COMPONENTS
      (experimental) The ExecuteComponents action runs components that are specified in the recipe for the current image being built.

    • EXECUTE_STATE_MACHINE

      @Stability(Experimental) public static final WorkflowAction EXECUTE_STATE_MACHINE
      (experimental) The ExecuteStateMachine action executes a the state machine provided and waits for completion as part of the workflow.

    • LAUNCH_INSTANCE

      @Stability(Experimental) public static final WorkflowAction LAUNCH_INSTANCE
      (experimental) The LaunchInstance action launches an instance using the settings from your recipe and infrastructure configuration resources.

    • MODIFY_IMAGE_ATTRIBUTES

      @Stability(Experimental) public static final WorkflowAction MODIFY_IMAGE_ATTRIBUTES
      (experimental) Applies attribute updates to the provided set of distributed images, such as launch permission updates.

    • RUN_COMMAND

      @Stability(Experimental) public static final WorkflowAction RUN_COMMAND
      (experimental) The RunCommand action runs a command document against the provided instance.

    • REGISTER_IMAGE

      @Stability(Experimental) public static final WorkflowAction REGISTER_IMAGE
      (experimental) The RegisterImage action creates an AMI from a set of snapshots with the ec2:RegisterImage API.

    • RUN_SYS_PREP

      @Stability(Experimental) public static final WorkflowAction RUN_SYS_PREP
      (experimental) The RunSysprep action runs the Sysprep document on the provided Windows instance.

    • SANITIZE_INSTANCE

      @Stability(Experimental) public static final WorkflowAction SANITIZE_INSTANCE
      (experimental) The SanitizeInstance action runs a recommended sanitization script on Linux instances.

    • TERMINATE_INSTANCE

      @Stability(Experimental) public static final WorkflowAction TERMINATE_INSTANCE
      (experimental) The TerminateInstance action terminates the provided instance.

    • WAIT_FOR_ACTION

      @Stability(Experimental) public static final WorkflowAction WAIT_FOR_ACTION
      (experimental) The WaitForAction action pauses the workflow and waits to receive an external signal from the imagebuilder:SendWorkflowStepAction API.

    • WAIT_FOR_SSM_AGENT

      @Stability(Experimental) public static final WorkflowAction WAIT_FOR_SSM_AGENT
      (experimental) The WaitForSSMAgent action waits for the given instance to have connectivity with SSM before proceeding.

  • Method Details

    • values

      public static WorkflowAction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static WorkflowAction valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null