AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ImageBuilder::ImagePipeline

CfnImagePipeline

An image pipeline is the automation configuration for building secure OS images on AWS . The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance types, a subnet for your VPC, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

Import

import { CfnImagePipeline } from 'aws-cdk-lib/aws-imagebuilder';

Or use the module namespace:

import * as imagebuilder from 'aws-cdk-lib/aws-imagebuilder';
// imagebuilder.CfnImagePipeline

Properties

Configuration passed to the constructor as CfnImagePipelineProps.

infrastructureConfigurationArnRequired
string | IInfrastructureConfigurationRef

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

nameRequired
string

The name of the image pipeline.

containerRecipeArnOptional
string | IContainerRecipeRef

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

descriptionOptional
string

The description of this image pipeline.

distributionConfigurationArnOptional
string | IDistributionConfigurationRef

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

enhancedImageMetadataEnabledOptional
boolean | IResolvable

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

executionRoleOptional
string

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

imageRecipeArnOptional
string | IImageRecipeRef

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

imageScanningConfigurationOptional
IResolvable | ImageScanningConfigurationProperty

Contains settings for vulnerability scans.

imageTestsConfigurationOptional
IResolvable | ImageTestsConfigurationProperty

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

loggingConfigurationOptional
IResolvable | PipelineLoggingConfigurationProperty

Defines logging configuration for the output image.

scheduleOptional
IResolvable | ScheduleProperty

The schedule of the image pipeline. A schedule configures how often and when a pipeline automatically creates a new image.

statusOptional
string

The status of the image pipeline.

tagsOptional
{ [key: string]: string }

The tags of this image pipeline.

workflowsOptional
IResolvable | IResolvable | WorkflowConfigurationProperty[]

Contains the workflows that run for the image pipeline.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ImageBuilder::ImagePipelineView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-imagebuilder
CFN TypeAWS::ImageBuilder::ImagePipeline
Properties15

Related Constructs

Explore This Service

External Links