aws-cdk-lib.aws_imagebuilder.CfnImageProps

interface CfnImageProps

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

Properties for defining a CfnImage.

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 cfnImageProps: imagebuilder.CfnImageProps = {
  infrastructureConfigurationArn: 'infrastructureConfigurationArn',

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

Properties

NameTypeDescription
infrastructureConfigurationArnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
containerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
distributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration.
enhancedImageMetadataEnabled?boolean | IResolvableIndicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
imageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe.
imageScanningConfiguration?IResolvable | ImageScanningConfigurationPropertyAWS::ImageBuilder::Image.ImageScanningConfiguration.
imageTestsConfiguration?IResolvable | ImageTestsConfigurationPropertyThe configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
tags?{ [string]: string }The tags of the image.

infrastructureConfigurationArn

Type: string

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


containerRecipeArn?

Type: string (optional)

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


distributionConfigurationArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the distribution configuration.


enhancedImageMetadataEnabled?

Type: boolean | IResolvable (optional)

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.


imageRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the image recipe.


imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

AWS::ImageBuilder::Image.ImageScanningConfiguration.


imageTestsConfiguration?

Type: IResolvable | ImageTestsConfigurationProperty (optional)

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.


tags?

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

The tags of the image.