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

Interface WorkflowConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WorkflowConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:50.103Z")
@Stability(Experimental)
public interface WorkflowConfiguration
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration details for a workflow.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.alpha.*;
 Workflow workflow;
 WorkflowParameterValue workflowParameterValue;
 WorkflowConfiguration workflowConfiguration = WorkflowConfiguration.builder()
         .workflow(workflow)
         // the properties below are optional
         .onFailure(WorkflowOnFailure.ABORT)
         .parallelGroup("parallelGroup")
         .parameters(Map.of(
                 "parametersKey", workflowParameterValue))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WorkflowConfiguration.Builder	A builder for WorkflowConfiguration
static final class	WorkflowConfiguration.Jsii$Proxy	An implementation for WorkflowConfiguration

Method Summary

Modifier and Type	Method	Description
static WorkflowConfiguration.Builder	builder()
default WorkflowOnFailure	getOnFailure()	(experimental) The action to take if the workflow fails.
default String	getParallelGroup()	(experimental) The named parallel group to include this workflow in.
default Map<String,WorkflowParameterValue>	getParameters()	(experimental) The parameters to pass to the workflow at execution time.
IWorkflow	getWorkflow()	(experimental) The workflow to execute in the image build.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getWorkflow

@Stability(Experimental)
@NotNull
IWorkflow getWorkflow()

(experimental) The workflow to execute in the image build.

getOnFailure

@Stability(Experimental)
@Nullable
default WorkflowOnFailure getOnFailure()

(experimental) The action to take if the workflow fails.

Default: WorkflowOnFailure.ABORT

getParallelGroup

@Stability(Experimental)
@Nullable
default String getParallelGroup()

(experimental) The named parallel group to include this workflow in.

Workflows in the same parallel group run in parallel of each other.

Default: None

getParameters

@Stability(Experimental)
@Nullable
default Map<String,WorkflowParameterValue> getParameters()

(experimental) The parameters to pass to the workflow at execution time.

Default: - none if the workflow has no parameters, otherwise the default parameter values are used

builder

@Stability(Experimental)
static WorkflowConfiguration.Builder builder()

Returns:

a WorkflowConfiguration.Builder of WorkflowConfiguration