interface CfnImageProps

Language	Type name
.NET	`Amazon.CDK.AWS.ImageBuilder.CfnImageProps`
Java	`software.amazon.awscdk.services.imagebuilder.CfnImageProps`
Python	`aws_cdk.aws_imagebuilder.CfnImageProps`
TypeScript	`@aws-cdk/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 * as imagebuilder from '@aws-cdk/aws-imagebuilder';
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

Name	Type	Description
infrastructureConfigurationArn	`string`	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
containerRecipeArn?	`string`	The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
distributionConfigurationArn?	`string`	The Amazon Resource Name (ARN) of the distribution configuration.
enhancedImageMetadataEnabled?	`boolean \|` `IResolvable`	Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
imageRecipeArn?	`string`	The Amazon Resource Name (ARN) of the image recipe.
imageScanningConfiguration?	`IResolvable` `\|` `ImageScanningConfigurationProperty`	`AWS::ImageBuilder::Image.ImageScanningConfiguration`.
imageTestsConfiguration?	`IResolvable` `\|` `ImageTestsConfigurationProperty`	The 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.