AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ImagePipelineProps Struct ​

Properties for creating an Image Pipeline resource.

Stability
Experimental
Source
lib/image-pipeline.ts

Example ​

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

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#
The description of the image pipeline.
distributionConfigurationoptionalIDistributionConfigurationdistribution_configurationoptionalIDistributionConfigurationdistributionConfigurationoptionalIDistributionConfigurationDistributionConfigurationoptionalIDistributionConfigurationDistributionConfigurationoptionalIDistributionConfiguration= None#
The distribution configuration used for distributing the image.
enhancedImageMetadataEnabledoptionalbooleanenhanced_image_metadata_enabledoptionalboolenhancedImageMetadataEnabledoptionalBooleanEnhancedImageMetadataEnabledoptionalboolEnhancedImageMetadataEnabledoptional*bool= true#
If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#
The execution role used to perform workflow actions to build this image.

Default: Image Builder will use the SLR if possible. Otherwise, an execution role will be generated

notes

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.

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

Default: a log group will be created

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

imagePipelineLogGroupoptionalILogGroupimage_pipeline_log_groupoptionalILogGroupimagePipelineLogGroupoptionalILogGroupImagePipelineLogGroupoptionalILogGroupImagePipelineLogGroupoptionalILogGroup#
The log group to use for the image pipeline.

Default: a log group will be created

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

imagePipelineNameoptionalstringimage_pipeline_nameoptionalstrimagePipelineNameoptionalStringImagePipelineNameoptionalstringImagePipelineNameoptional*string#
The name of the image pipeline.

Default: a name is generated

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

Default: if scanning is enabled, a repository will be created by Image Builder if one is not provided

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

imageScanningEcrTagsoptionalstring[]image_scanning_ecr_tagsoptionaltyping.List[str]imageScanningEcrTagsoptionalList<String>ImageScanningEcrTagsoptionalstring[]ImageScanningEcrTagsoptional*[]*string= None#
The tags for Image Builder to apply to the output container image that Amazon Inspector scans.
imageScanningEnabledoptionalbooleanimage_scanning_enabledoptionalboolimageScanningEnabledoptionalBooleanImageScanningEnabledoptionalboolImageScanningEnabledoptional*bool= 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.
imageTestsEnabledoptionalbooleanimage_tests_enabledoptionalboolimageTestsEnabledoptionalBooleanImageTestsEnabledoptionalboolImageTestsEnabledoptional*bool= true#
Whether to run tests after building an image.
infrastructureConfigurationoptionalIInfrastructureConfigurationinfrastructure_configurationoptionalIInfrastructureConfigurationinfrastructureConfigurationoptionalIInfrastructureConfigurationInfrastructureConfigurationoptionalIInfrastructureConfigurationInfrastructureConfigurationoptionalIInfrastructureConfiguration#
The infrastructure configuration used for building the image.

Default: an infrastructure configuration will be created with the default settings

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.

recipeIRecipeBaserecipeIRecipeBaserecipeIRecipeBaseRecipeIRecipeBaseRecipeIRecipeBaserequired#
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.

scheduleoptionalImagePipelineSchedulescheduleoptionalImagePipelineSchedulescheduleoptionalImagePipelineScheduleScheduleoptionalImagePipelineScheduleScheduleoptionalImagePipelineSchedule#
The schedule of the image pipeline.

Default: none, a manual image pipeline will be created

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

statusoptionalImagePipelineStatusstatusoptionalImagePipelineStatusstatusoptionalImagePipelineStatusStatusoptionalImagePipelineStatusStatusoptionalImagePipelineStatus= ImagePipelineStatus.ENABLED#
Indicates whether the pipeline is enabled to be triggered by the provided schedule.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string= None#
The tags to apply to the image pipeline.
workflowsoptionalWorkflowConfiguration[]workflowsoptionaltyping.List[WorkflowConfiguration]workflowsoptionalList<WorkflowConfiguration>WorkflowsoptionalWorkflowConfiguration[]Workflowsoptional*[]WorkflowConfiguration#
The list of workflow configurations used to build the image.

Default: Image Builder will use a default set of workflows for the build to build, test, and distribute the image