aws-cdk-lib.aws_imagebuilder.CfnImagePipelineProps

interface CfnImagePipelineProps

LanguageType name
.NETAmazon.CDK.AWS.ImageBuilder.CfnImagePipelineProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImagePipelineProps
Javasoftware.amazon.awscdk.services.imagebuilder.CfnImagePipelineProps
Pythonaws_cdk.aws_imagebuilder.CfnImagePipelineProps
TypeScript aws-cdk-lib » aws_imagebuilder » CfnImagePipelineProps

Properties for defining a CfnImagePipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const cfnImagePipelineProps: imagebuilder.CfnImagePipelineProps = {
  infrastructureConfigurationArn: 'infrastructureConfigurationArn',
  name: 'name',

  // the properties below are optional
  containerRecipeArn: 'containerRecipeArn',
  description: 'description',
  distributionConfigurationArn: 'distributionConfigurationArn',
  enhancedImageMetadataEnabled: false,
  imageRecipeArn: 'imageRecipeArn',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: ['containerTags'],
      repositoryName: 'repositoryName',
    },
    imageScanningEnabled: false,
  },
  imageTestsConfiguration: {
    imageTestsEnabled: false,
    timeoutMinutes: 123,
  },
  schedule: {
    pipelineExecutionStartCondition: 'pipelineExecutionStartCondition',
    scheduleExpression: 'scheduleExpression',
  },
  status: 'status',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
infrastructureConfigurationArnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
namestringThe name of the image pipeline.
containerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
description?stringThe description of this image pipeline.
distributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
enhancedImageMetadataEnabled?boolean | IResolvableCollects additional information about the image being created, including the operating system (OS) version and package list.
imageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
imageScanningConfiguration?IResolvable | ImageScanningConfigurationPropertyAWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.
imageTestsConfiguration?IResolvable | ImageTestsConfigurationPropertyThe configuration of the image tests that run after image creation to ensure the quality of the image that was created.
schedule?IResolvable | SchedulePropertyThe schedule of the image pipeline.
status?stringThe status of the image pipeline.
tags?{ [string]: string }The tags of this image pipeline.

infrastructureConfigurationArn

Type: string

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


name

Type: string

The name of the image pipeline.


containerRecipeArn?

Type: string (optional)

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


description?

Type: string (optional)

The description of this image pipeline.


distributionConfigurationArn?

Type: string (optional)

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


enhancedImageMetadataEnabled?

Type: boolean | IResolvable (optional)

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.


imageRecipeArn?

Type: string (optional)

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


imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.


imageTestsConfiguration?

Type: IResolvable | ImageTestsConfigurationProperty (optional)

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


schedule?

Type: IResolvable | ScheduleProperty (optional)

The schedule of the image pipeline.

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


status?

Type: string (optional)

The status of the image pipeline.


tags?

Type: { [string]: string } (optional)

The tags of this image pipeline.