class ImagePipeline (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IImagePipeline

Represents an EC2 Image Builder Image Pipeline.

Example

const workflowPipeline = new imagebuilder.ImagePipeline(this, 'WorkflowPipeline', {
  recipe: exampleImageRecipe,
  workflows: [
    { workflow: imagebuilder.AwsManagedWorkflow.buildImage(this, 'BuildWorkflow') },
    { workflow: imagebuilder.AwsManagedWorkflow.testImage(this, 'TestWorkflow') }
  ]
});

Initializer

new ImagePipeline(scope: Construct, id: string, props: ImagePipelineProps)

Parameters

scope Construct
id string
props ImagePipelineProps

Construct Props

Name	Type	Description
recipe🔹	`IRecipeBase`	The recipe that defines the base image, components, and customizations used to build the image.
description?🔹	`string`	The description of the image pipeline.
distributionConfiguration?🔹	`IDistributionConfiguration`	The distribution configuration used for distributing the image.
enhancedImageMetadataEnabled?🔹	`boolean`	If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.
executionRole?🔹	`IRole`	The execution role used to perform workflow actions to build this image.
imageLogGroup?🔹	`ILogGroup`	The log group to use for images created from the image pipeline.
imagePipelineLogGroup?🔹	`ILogGroup`	The log group to use for the image pipeline.
imagePipelineName?🔹	`string`	The name of the image pipeline.
imageScanningEcrRepository?🔹	`IRepository`	The container repository that Amazon Inspector scans to identify findings for your container images.
imageScanningEcrTags?🔹	`string[]`	The tags for Image Builder to apply to the output container image that Amazon Inspector scans.
imageScanningEnabled?🔹	`boolean`	Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
imageTestsEnabled?🔹	`boolean`	Whether to run tests after building an image.
infrastructureConfiguration?🔹	`IInfrastructureConfiguration`	The infrastructure configuration used for building the image.
schedule?🔹	`ImagePipelineSchedule`	The schedule of the image pipeline.
status?🔹	`ImagePipelineStatus`	Indicates whether the pipeline is enabled to be triggered by the provided schedule.
tags?🔹	`{ [string]: string }`	The tags to apply to the image pipeline.
workflows?🔹	`WorkflowConfiguration[]`	The list of workflow configurations used to build the image.

recipe🔹

Type: IRecipeBase

The recipe that defines the base image, components, and customizations used to build the image.

This can either be an image recipe, or a container recipe.

description?🔹

Type: string (optional, default: None)

The description of the image pipeline.

distributionConfiguration?🔹

Type: IDistributionConfiguration (optional, default: None)

The distribution configuration used for distributing the image.

enhancedImageMetadataEnabled?🔹

Type: boolean (optional, default: true)

If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.

executionRole?🔹

Type: IRole (optional, default: Image Builder will use the SLR if possible. Otherwise, an execution role will be generated)

The execution role used to perform workflow actions to build this image.

By default, the Image Builder Service Linked Role (SLR) will be created automatically and used as the execution role. However, when providing a custom set of image workflows for the pipeline, an execution role will be generated with the minimal permissions needed to execute the workflows.

imageLogGroup?🔹

Type: ILogGroup (optional, default: a log group will be created)

The log group to use for images created from the image pipeline.

By default, a log group will be created with the format /aws/imagebuilder/<image-name>.

imagePipelineLogGroup?🔹

Type: ILogGroup (optional, default: a log group will be created)

The log group to use for the image pipeline.

By default, a log group will be created with the format /aws/imagebuilder/pipeline/<pipeline-name>

imagePipelineName?🔹

Type: string (optional, default: a name is generated)

The name of the image pipeline.

imageScanningEcrRepository?🔹

Type: IRepository (optional, default: if scanning is enabled, a repository will be created by Image Builder if one is not provided)

The container repository that Amazon Inspector scans to identify findings for your container images.

If a repository is not provided, Image Builder creates a repository named image-builder-image-scanning-repository for vulnerability scanning.

imageScanningEcrTags?🔹

Type: string[] (optional, default: None)

The tags for Image Builder to apply to the output container image that Amazon Inspector scans.

imageScanningEnabled?🔹

Type: boolean (optional, default: false)

Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

imageTestsEnabled?🔹

Type: boolean (optional, default: true)

Whether to run tests after building an image.

infrastructureConfiguration?🔹

Type: IInfrastructureConfiguration (optional, default: an infrastructure configuration will be created with the default settings)

The infrastructure configuration used for building the image.

A default infrastructure configuration will be used if one is not provided.

The default configuration will create an instance profile and role with minimal permissions needed to build the image, attached to the EC2 instance.

schedule?🔹

Type: ImagePipelineSchedule (optional, default: none, a manual image pipeline will be created)

The schedule of the image pipeline.

This configures how often and when a pipeline automatically creates a new image.

status?🔹

Type: ImagePipelineStatus (optional, default: ImagePipelineStatus.ENABLED)

Indicates whether the pipeline is enabled to be triggered by the provided schedule.

tags?🔹

Type: { [string]: string } (optional, default: None)

The tags to apply to the image pipeline.

workflows?🔹

Type: WorkflowConfiguration[] (optional, default: Image Builder will use a default set of workflows for the build to build, test, and distribute the image)

The list of workflow configurations used to build the image.

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.
infrastructureConfiguration🔹	`IInfrastructureConfiguration`	The infrastructure configuration used for the image build.
node🔹	`Node`	The tree node.
stack🔹	`Stack`	The stack in which this resource is defined.
executionRole?🔹	`IRole`	The execution role used for the image build.
static PROPERTY_INJECTION_ID🔹	`string`	Uniquely identifies this class.

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.

infrastructureConfiguration🔹

Type: IInfrastructureConfiguration

The infrastructure configuration used for the image build.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

executionRole?🔹

Type: IRole (optional)

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.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

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.
toString()🔹	Returns a string representation of this construct.
static fromImagePipelineArn(scope, id, imagePipelineArn)🔹	Import an existing image pipeline given its ARN.
static fromImagePipelineName(scope, id, imagePipelineName)🔹	Import an existing image pipeline given its name.
static isImagePipeline(x)🔹	Return whether the given object is an ImagePipeline.

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.

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.

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.

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.

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.

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.

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.

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.

toString()🔹

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromImagePipelineArn(scope, id, imagePipelineArn)🔹

public static fromImagePipelineArn(scope: Construct, id: string, imagePipelineArn: string): IImagePipeline

Parameters

scope Construct
id string
imagePipelineArn string

Returns

IImagePipeline

Import an existing image pipeline given its ARN.

static fromImagePipelineName(scope, id, imagePipelineName)🔹

public static fromImagePipelineName(scope: Construct, id: string, imagePipelineName: string): IImagePipeline

Parameters

scope Construct
id string
imagePipelineName string

Returns

IImagePipeline

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.

static isImagePipeline(x)🔹

public static isImagePipeline(x: any): boolean

Parameters

x any

Returns

boolean

Return whether the given object is an ImagePipeline.