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

Class ImagePipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.imagebuilder.alpha.ImagePipeline

All Implemented Interfaces:

IEnvironmentAware, IResource, IImagePipeline, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:50.058Z")
@Stability(Experimental)
public class ImagePipeline
extends Resource
implements IImagePipeline

(experimental) Represents an EC2 Image Builder Image Pipeline.

Example:

 ImagePipeline workflowPipeline = ImagePipeline.Builder.create(this, "WorkflowPipeline")
         .recipe(exampleImageRecipe)
         .workflows(List.of(WorkflowConfiguration.builder().workflow(AwsManagedWorkflow.buildImage(this, "BuildWorkflow")).build(), WorkflowConfiguration.builder().workflow(AwsManagedWorkflow.testImage(this, "TestWorkflow")).build()))
         .build();
 

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/manage-pipelines.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImagePipeline.Builder	(experimental) A fluent builder for ImagePipeline.

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.services.imagebuilder.alpha.IImagePipeline

IImagePipeline.Jsii$Default, IImagePipeline.Jsii$Proxy

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImagePipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ImagePipeline(software.amazon.jsii.JsiiObjectRef objRef)
	ImagePipeline(software.constructs.Construct scope, String id, ImagePipelineProps props)

Method Summary

Modifier and Type	Method	Description
static IImagePipeline	fromImagePipelineArn(software.constructs.Construct scope, String id, String imagePipelineArn)	(experimental) Import an existing image pipeline given its ARN.
static IImagePipeline	fromImagePipelineName(software.constructs.Construct scope, String id, String imagePipelineName)	(experimental) Import an existing image pipeline given its name.
IRole	getExecutionRole()	(experimental) The execution role used for the image build.
String	getImagePipelineArn()	(experimental) The ARN of the image pipeline.
String	getImagePipelineName()	(experimental) The name of the image pipeline.
IInfrastructureConfiguration	getInfrastructureConfiguration()	(experimental) The infrastructure configuration used for the image build.
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant custom actions to the given grantee for the image pipeline.
List<Grant>	grantDefaultExecutionRolePermissions(IGrantable grantee)	(experimental) Grants the default permissions for building an image to the provided execution role.
Grant	grantRead(IGrantable grantee)	(experimental) Grant read permissions to the given grantee for the image pipeline.
Grant	grantStartExecution(IGrantable grantee)	(experimental) Grant permissions to the given grantee to start an execution of the image pipeline.
static Boolean	isImagePipeline(Object x)	(experimental) Return whether the given object is an ImagePipeline.
Rule	onCVEDetected(String id)	(experimental) Creates an EventBridge rule for Image Builder CVE detected events.
Rule	onCVEDetected(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder CVE detected events.
Rule	onEvent(String id)	(experimental) Creates an EventBridge rule for Image Builder events.
Rule	onEvent(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder events.
Rule	onImageBuildCompleted(String id)	(experimental) Creates an EventBridge rule for Image Builder image build completion events.
Rule	onImageBuildCompleted(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image build completion events.
Rule	onImageBuildFailed(String id)	(experimental) Creates an EventBridge rule for Image Builder image build failure events.
Rule	onImageBuildFailed(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image build failure events.
Rule	onImageBuildStateChange(String id)	(experimental) Creates an EventBridge rule for Image Builder image state change events.
Rule	onImageBuildStateChange(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image state change events.
Rule	onImageBuildSucceeded(String id)	(experimental) Creates an EventBridge rule for Image Builder image success events.
Rule	onImageBuildSucceeded(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image success events.
Rule	onImagePipelineAutoDisabled(String id)	(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.
Rule	onImagePipelineAutoDisabled(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.
Rule	onWaitForAction(String id)	(experimental) Creates an EventBridge rule for Image Builder wait for action events.
Rule	onWaitForAction(String id, OnEventOptions options)	(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

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

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

ImagePipeline

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

ImagePipeline

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

ImagePipeline

@Stability(Experimental)
public ImagePipeline(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ImagePipelineProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromImagePipelineArn

@Stability(Experimental)
@NotNull
public static IImagePipeline fromImagePipelineArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String imagePipelineArn)

(experimental) Import an existing image pipeline given its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

imagePipelineArn - This parameter is required.

fromImagePipelineName

@Stability(Experimental)
@NotNull
public static IImagePipeline fromImagePipelineName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String imagePipelineName)

(experimental) Import an existing image pipeline given its name.

The provided name must be normalized by converting all alphabetical characters to lowercase, and replacing all spaces and underscores with hyphens.

Parameters:

scope - This parameter is required.

id - This parameter is required.

imagePipelineName - This parameter is required.

isImagePipeline

@Stability(Experimental)
@NotNull
public static Boolean isImagePipeline(@NotNull
 Object x)

(experimental) Return whether the given object is an ImagePipeline.

Parameters:

x - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant custom actions to the given grantee for the image pipeline.

Specified by:

grant in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

actions - The list of actions. This parameter is required.

grantDefaultExecutionRolePermissions

@Stability(Experimental)
@NotNull
public List<Grant> grantDefaultExecutionRolePermissions(@NotNull
 IGrantable grantee)

(experimental) Grants the default permissions for building an image to the provided execution role.

Specified by:

grantDefaultExecutionRolePermissions in interface IImagePipeline

Parameters:

grantee - The execution role used for the image build. This parameter is required.

grantRead

@Stability(Experimental)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

(experimental) Grant read permissions to the given grantee for the image pipeline.

Specified by:

grantRead in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

grantStartExecution

@Stability(Experimental)
@NotNull
public Grant grantStartExecution(@NotNull
 IGrantable grantee)

(experimental) Grant permissions to the given grantee to start an execution of the image pipeline.

Specified by:

grantStartExecution in interface IImagePipeline

Parameters:

grantee - The principal. This parameter is required.

onCVEDetected

@Stability(Experimental)
@NotNull
public Rule onCVEDetected(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder CVE detected events.

Specified by:

onCVEDetected in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onCVEDetected

@Stability(Experimental)
@NotNull
public Rule onCVEDetected(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder CVE detected events.

Specified by:

onCVEDetected in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onEvent

@Stability(Experimental)
@NotNull
public Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder events.

Specified by:

onEvent in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onEvent

@Stability(Experimental)
@NotNull
public Rule onEvent(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder events.

Specified by:

onEvent in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildCompleted

@Stability(Experimental)
@NotNull
public Rule onImageBuildCompleted(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image build completion events.

Specified by:

onImageBuildCompleted in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildCompleted

@Stability(Experimental)
@NotNull
public Rule onImageBuildCompleted(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder image build completion events.

Specified by:

onImageBuildCompleted in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildFailed

@Stability(Experimental)
@NotNull
public Rule onImageBuildFailed(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image build failure events.

Specified by:

onImageBuildFailed in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildFailed

@Stability(Experimental)
@NotNull
public Rule onImageBuildFailed(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder image build failure events.

Specified by:

onImageBuildFailed in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildStateChange

@Stability(Experimental)
@NotNull
public Rule onImageBuildStateChange(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image state change events.

Specified by:

onImageBuildStateChange in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildStateChange

@Stability(Experimental)
@NotNull
public Rule onImageBuildStateChange(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder image state change events.

Specified by:

onImageBuildStateChange in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildSucceeded

@Stability(Experimental)
@NotNull
public Rule onImageBuildSucceeded(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image success events.

Specified by:

onImageBuildSucceeded in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImageBuildSucceeded

@Stability(Experimental)
@NotNull
public Rule onImageBuildSucceeded(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder image success events.

Specified by:

onImageBuildSucceeded in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImagePipelineAutoDisabled

@Stability(Experimental)
@NotNull
public Rule onImagePipelineAutoDisabled(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.

Specified by:

onImagePipelineAutoDisabled in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onImagePipelineAutoDisabled

@Stability(Experimental)
@NotNull
public Rule onImagePipelineAutoDisabled(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.

Specified by:

onImagePipelineAutoDisabled in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onWaitForAction

@Stability(Experimental)
@NotNull
public Rule onWaitForAction(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Specified by:

onWaitForAction in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

options - Configuration options for the event rule.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

onWaitForAction

@Stability(Experimental)
@NotNull
public Rule onWaitForAction(@NotNull
 String id)

(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Specified by:

onWaitForAction in interface IImagePipeline

Parameters:

id - Unique identifier for the rule. This parameter is required.

See Also:

• https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

getImagePipelineArn

@Stability(Experimental)
@NotNull
public String getImagePipelineArn()

(experimental) The ARN of the image pipeline.

Specified by:

getImagePipelineArn in interface IImagePipeline

getImagePipelineName

@Stability(Experimental)
@NotNull
public String getImagePipelineName()

(experimental) The name of the image pipeline.

Specified by:

getImagePipelineName in interface IImagePipeline

getInfrastructureConfiguration

@Stability(Experimental)
@NotNull
public IInfrastructureConfiguration getInfrastructureConfiguration()

(experimental) The infrastructure configuration used for the image build.

getExecutionRole

@Stability(Experimental)
@Nullable
public IRole getExecutionRole()

(experimental) The execution role used for the image build.

If there is no execution role, then the build will be executed with the AWSServiceRoleForImageBuilder service-linked role.