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

Interface IImagePipeline

All Superinterfaces:

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

All Known Subinterfaces:

IImagePipeline.Jsii$Default

All Known Implementing Classes:

IImagePipeline.Jsii$Proxy, ImagePipeline

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:04:05.895Z")
@Stability(Experimental)
public interface IImagePipeline
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) An EC2 Image Builder Image Pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IImagePipeline.Jsii$Default	Internal default implementation for IImagePipeline.
static final class	IImagePipeline.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getImagePipelineArn()	(experimental) The ARN of the image pipeline.
String	getImagePipelineName()	(experimental) The name of the image pipeline.
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.
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 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

Method Details

getImagePipelineArn

@Stability(Experimental)
@NotNull
String getImagePipelineArn()

(experimental) The ARN of the image pipeline.

getImagePipelineName

@Stability(Experimental)
@NotNull
String getImagePipelineName()

(experimental) The name of the image pipeline.

grant

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

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

Parameters:

grantee - The principal. This parameter is required.

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

grantDefaultExecutionRolePermissions

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

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

Parameters:

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

grantRead

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

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

Parameters:

grantee - The principal. This parameter is required.

grantStartExecution

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

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

Parameters:

grantee - The principal. This parameter is required.

onCVEDetected

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

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

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
Rule onCVEDetected(@NotNull
 String id)

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

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
Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onEvent(@NotNull
 String id)

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

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
Rule onImageBuildCompleted(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onImageBuildCompleted(@NotNull
 String id)

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

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
Rule onImageBuildFailed(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onImageBuildFailed(@NotNull
 String id)

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

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
Rule onImageBuildStateChange(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onImageBuildStateChange(@NotNull
 String id)

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

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
Rule onImageBuildSucceeded(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onImageBuildSucceeded(@NotNull
 String id)

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

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
Rule onImagePipelineAutoDisabled(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onImagePipelineAutoDisabled(@NotNull
 String id)

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

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
Rule onWaitForAction(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

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
Rule onWaitForAction(@NotNull
 String id)

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

Parameters:

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

See Also:

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