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

Interface WorkflowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WorkflowProps.Jsii$Proxy

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

(experimental) Properties for creating a Workflow resource.

Example:

 Workflow workflow = Workflow.Builder.create(this, "EncryptedWorkflow")
         .workflowType(WorkflowType.BUILD)
         .kmsKey(new Key(this, "WorkflowKey"))
         .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", "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

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

Method Summary

Modifier and Type	Method	Description
static WorkflowProps.Builder	builder()
default String	getChangeDescription()	(experimental) The change description of the workflow.
WorkflowData	getData()	(experimental) The workflow document content that defines the image creation process.
default String	getDescription()	(experimental) The description of the workflow.
default IKey	getKmsKey()	(experimental) The KMS key used to encrypt this workflow.
default Map<String,String>	getTags()	(experimental) The tags to apply to the workflow.
default String	getWorkflowName()	(experimental) The name of the workflow.
WorkflowType	getWorkflowType()	(experimental) The phase in the image build process for which the workflow resource is responsible.
default String	getWorkflowVersion()	(experimental) The version of the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getData

@Stability(Experimental)
@NotNull
WorkflowData getData()

(experimental) The workflow document content that defines the image creation process.

getWorkflowType

@Stability(Experimental)
@NotNull
WorkflowType getWorkflowType()

(experimental) The phase in the image build process for which the workflow resource is responsible.

getChangeDescription

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

(experimental) The change description of the workflow.

Describes what change has been made in this version of the workflow, or what makes this version different from other versions.

Default: None

getDescription

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

(experimental) The description of the workflow.

Default: None

getKmsKey

@Stability(Experimental)
@Nullable
default IKey getKmsKey()

(experimental) The KMS key used to encrypt this workflow.

Default: - an Image Builder owned key will be used to encrypt the workflow.

getTags

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

(experimental) The tags to apply to the workflow.

Default: None

getWorkflowName

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

(experimental) The name of the workflow.

Default: - a name is generated

getWorkflowVersion

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

(experimental) The version of the workflow.

Default: 1.0.0

builder

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

Returns:

a WorkflowProps.Builder of WorkflowProps