interface ImagePipelineProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ImageBuilder.Alpha.ImagePipelineProps |
 Go | github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ImagePipelineProps |
 Java | software.amazon.awscdk.services.imagebuilder.alpha.ImagePipelineProps |
 Python | aws_cdk.aws_imagebuilder_alpha.ImagePipelineProps |
 TypeScript (source) | @aws-cdk/aws-imagebuilder-alpha » ImagePipelineProps |
Properties for creating an Image Pipeline resource.
Example
const workflowPipeline = new imagebuilder.ImagePipeline(this, 'WorkflowPipeline', {
recipe: exampleImageRecipe,
workflows: [
{ workflow: imagebuilder.AwsManagedWorkflow.buildImage(this, 'BuildWorkflow') },
{ workflow: imagebuilder.AwsManagedWorkflow.testImage(this, 'TestWorkflow') }
]
});
Properties
| Name | Type | Description |
|---|---|---|
| recipe | IRecipe | The recipe that defines the base image, components, and customizations used to build the image. |
| description? | string | The description of the image pipeline. |
| distribution | IDistribution | The distribution configuration used for distributing the image. |
| enhanced | boolean | If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI. |
| execution | IRole | The execution role used to perform workflow actions to build this image. |
| image | ILog | The log group to use for images created from the image pipeline. |
| image | ILog | The log group to use for the image pipeline. |
| image | string | The name of the image pipeline. |
| image | IRepository | The container repository that Amazon Inspector scans to identify findings for your container images. |
| image | string[] | The tags for Image Builder to apply to the output container image that Amazon Inspector scans. |
| image | 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. |
| image | boolean | Whether to run tests after building an image. |
| infrastructure | IInfrastructure | The infrastructure configuration used for building the image. |
| schedule? | Image | The schedule of the image pipeline. |
| status? | Image | 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? | Workflow[] | The list of workflow configurations used to build the image. |
recipe
Type:
IRecipe
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:
IDistribution
(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:
ILog
(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:
ILog
(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:
IInfrastructure
(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:
Image
(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:
Image
(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:
Workflow[]
(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.