Package software.amazon.awscdk.services.imagebuilder

Class CfnWorkflowExecution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.imagebuilder.CfnWorkflowExecution

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IWorkflowExecutionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:04.907Z")
@Stability(Stable)
public class CfnWorkflowExecution
extends CfnResource
implements IInspectable, IWorkflowExecutionRef

Represents a runtime instance of an EC2 Image Builder workflow.

Workflow executions are created automatically when an image build runs 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.*;
 CfnWorkflowExecution cfnWorkflowExecution = CfnWorkflowExecution.Builder.create(this, "MyCfnWorkflowExecution")
         .imageBuildVersionArn("imageBuildVersionArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-workflowexecution.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnWorkflowExecution.Builder	A fluent builder for CfnWorkflowExecution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.imagebuilder.IWorkflowExecutionRef

IWorkflowExecutionRef.Jsii$Default, IWorkflowExecutionRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnWorkflowExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkflowExecution(software.amazon.jsii.JsiiObjectRef objRef)
	CfnWorkflowExecution(software.constructs.Construct scope, String id)	Create a new AWS::ImageBuilder::WorkflowExecution.
	CfnWorkflowExecution(software.constructs.Construct scope, String id, CfnWorkflowExecutionProps props)	Create a new AWS::ImageBuilder::WorkflowExecution.

Method Summary

Modifier and Type	Method	Description
static String	arnForWorkflowExecution(IWorkflowExecutionRef resource)
String	getAttrArn()	The Amazon Resource Name (ARN) of the workflow execution.
String	getAttrEndTime()	The timestamp when the specified runtime instance of the workflow finished.
String	getAttrStartTime()	The timestamp when the specified runtime instance of the workflow started.
String	getAttrStatus()	The current runtime status for the specified runtime instance of the workflow.
Number	getAttrTotalStepCount()	The total number of steps in the specified runtime instance of the workflow that ran.
Number	getAttrTotalStepsFailed()	A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
Number	getAttrTotalStepsSkipped()	A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
Number	getAttrTotalStepsSucceeded()	A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
String	getAttrType()	The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
String	getAttrWorkflowBuildVersionArn()	The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
String	getAttrWorkflowExecutionId()	The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getImageBuildVersionArn()	The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.
WorkflowExecutionReference	getWorkflowExecutionRef()	A reference to a WorkflowExecution resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnWorkflowExecution(Object x)	Checks whether the given object is a CfnWorkflowExecution.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setImageBuildVersionArn(String value)	The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnWorkflowExecution

protected CfnWorkflowExecution(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkflowExecution

protected CfnWorkflowExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkflowExecution

@Stability(Stable)
public CfnWorkflowExecution(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnWorkflowExecutionProps props)

Create a new AWS::ImageBuilder::WorkflowExecution.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnWorkflowExecution

@Stability(Stable)
public CfnWorkflowExecution(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::ImageBuilder::WorkflowExecution.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

arnForWorkflowExecution

@Stability(Stable)
@NotNull
public static String arnForWorkflowExecution(@NotNull
 IWorkflowExecutionRef resource)

Parameters:

resource - This parameter is required.

isCfnWorkflowExecution

@Stability(Stable)
@NotNull
public static Boolean isCfnWorkflowExecution(@NotNull
 Object x)

Checks whether the given object is a CfnWorkflowExecution.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the workflow execution.

getAttrEndTime

@Stability(Stable)
@NotNull
public String getAttrEndTime()

The timestamp when the specified runtime instance of the workflow finished.

getAttrStartTime

@Stability(Stable)
@NotNull
public String getAttrStartTime()

The timestamp when the specified runtime instance of the workflow started.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The current runtime status for the specified runtime instance of the workflow.

getAttrTotalStepCount

@Stability(Stable)
@NotNull
public Number getAttrTotalStepCount()

The total number of steps in the specified runtime instance of the workflow that ran.

getAttrTotalStepsFailed

@Stability(Stable)
@NotNull
public Number getAttrTotalStepsFailed()

A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

getAttrTotalStepsSkipped

@Stability(Stable)
@NotNull
public Number getAttrTotalStepsSkipped()

A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

getAttrTotalStepsSucceeded

@Stability(Stable)
@NotNull
public Number getAttrTotalStepsSucceeded()

A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.

getAttrType

@Stability(Stable)
@NotNull
public String getAttrType()

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

getAttrWorkflowBuildVersionArn

@Stability(Stable)
@NotNull
public String getAttrWorkflowBuildVersionArn()

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

getAttrWorkflowExecutionId

@Stability(Stable)
@NotNull
public String getAttrWorkflowExecutionId()

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getWorkflowExecutionRef

@Stability(Stable)
@NotNull
public WorkflowExecutionReference getWorkflowExecutionRef()

A reference to a WorkflowExecution resource.

Specified by:

getWorkflowExecutionRef in interface IWorkflowExecutionRef

getImageBuildVersionArn

@Stability(Stable)
@Nullable
public String getImageBuildVersionArn()

The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

setImageBuildVersionArn

@Stability(Stable)
public void setImageBuildVersionArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.