interface IImagePipeline 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.IImagePipeline
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#IImagePipeline
Java	software.amazon.awscdk.services.imagebuilder.alpha.IImagePipeline
Python	aws_cdk.aws_imagebuilder_alpha.IImagePipeline
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » IImagePipeline

Implemented by ImagePipeline

Obtainable from ImagePipeline.fromImagePipelineArn(), ImagePipeline.fromImagePipelineName()

An EC2 Image Builder Image Pipeline.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
imagePipelineArn🔹	string	The ARN of the image pipeline.
imagePipelineName🔹	string	The name of the image pipeline.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

imagePipelineArn🔹

Type: string

The ARN of the image pipeline.

---

imagePipelineName🔹

Type: string

The name of the image pipeline.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant custom actions to the given grantee for the image pipeline.
grantDefaultExecutionRolePermissions(grantee)🔹	Grants the default permissions for building an image to the provided execution role.
grantRead(grantee)🔹	Grant read permissions to the given grantee for the image pipeline.
grantStartExecution(grantee)🔹	Grant permissions to the given grantee to start an execution of the image pipeline.
onCVEDetected(id, options?)🔹	Creates an EventBridge rule for Image Builder CVE detected events.
onEvent(id, options?)🔹	Creates an EventBridge rule for Image Builder events.
onImageBuildCompleted(id, options?)🔹	Creates an EventBridge rule for Image Builder image build completion events.
onImageBuildFailed(id, options?)🔹	Creates an EventBridge rule for Image Builder image build failure events.
onImageBuildStateChange(id, options?)🔹	Creates an EventBridge rule for Image Builder image state change events.
onImageBuildSucceeded(id, options?)🔹	Creates an EventBridge rule for Image Builder image success events.
onImagePipelineAutoDisabled(id, options?)🔹	Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.
onWaitForAction(id, options?)🔹	Creates an EventBridge rule for Image Builder wait for action events.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• actions string — The list of actions.

Returns

• Grant

Grant custom actions to the given grantee for the image pipeline.

---

grantDefaultExecutionRolePermissions(grantee)🔹

public grantDefaultExecutionRolePermissions(grantee: IGrantable): Grant[]

Parameters

• grantee IGrantable — The execution role used for the image build.

Returns

• Grant[]

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

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Grant read permissions to the given grantee for the image pipeline.

---

grantStartExecution(grantee)🔹

public grantStartExecution(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

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

---

onCVEDetected(id, options?)🔹

public onCVEDetected(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

Creates an EventBridge rule for Image Builder CVE detected events.

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

---

onEvent(id, options?)🔹

public onEvent(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

Creates an EventBridge rule for Image Builder events.

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

---

onImageBuildCompleted(id, options?)🔹

public onImageBuildCompleted(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

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

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

---

onImageBuildFailed(id, options?)🔹

public onImageBuildFailed(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

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

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

---

onImageBuildStateChange(id, options?)🔹

public onImageBuildStateChange(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

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

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

---

onImageBuildSucceeded(id, options?)🔹

public onImageBuildSucceeded(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

Creates an EventBridge rule for Image Builder image success events.

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

---

onImagePipelineAutoDisabled(id, options?)🔹

public onImagePipelineAutoDisabled(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

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

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

---

onWaitForAction(id, options?)🔹

public onWaitForAction(id: string, options?: OnEventOptions): Rule

Parameters

• id string — Unique identifier for the rule.
• options OnEventOptions — Configuration options for the event rule.

Returns

• Rule

Creates an EventBridge rule for Image Builder wait for action events.

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