interface CfnImageProps

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnImageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImageProps
Java	software.amazon.awscdk.services.imagebuilder.CfnImageProps
Python	aws_cdk.aws_imagebuilder.CfnImageProps
TypeScript	aws-cdk-lib » aws_imagebuilder » CfnImageProps

Properties for defining a CfnImage.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html

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,
  executionRole: 'executionRole',
  imageRecipeArn: 'imageRecipeArn',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: ['containerTags'],
      repositoryName: 'repositoryName',
    },
    imageScanningEnabled: false,
  },
  imageTestsConfiguration: {
    imageTestsEnabled: false,
    timeoutMinutes: 123,
  },
  tags: {
    tagsKey: 'tags',
  },
  workflows: [{
    onFailure: 'onFailure',
    parallelGroup: 'parallelGroup',
    parameters: [{
      name: 'name',
      value: ['value'],
    }],
    workflowArn: 'workflowArn',
  }],
};

Properties

Name	Type	Description
infrastructureConfigurationArn	string	The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
containerRecipeArn?	string	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distributionConfigurationArn?	string	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
enhancedImageMetadataEnabled?	boolean | IResolvable	Collects additional information about the image being created, including the operating system (OS) version and package list.
executionRole?	string	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
imageRecipeArn?	string	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
imageScanningConfiguration?	IResolvable | ImageScanningConfigurationProperty	Contains settings for vulnerability scans.
imageTestsConfiguration?	IResolvable | ImageTestsConfigurationProperty	The image tests configuration of the image.
tags?	{ [string]: string }	The tags of the image.
workflows?	IResolvable | IResolvable | WorkflowConfigurationProperty[]	Contains an array of workflow configuration objects.

---

infrastructureConfigurationArn

Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-infrastructureconfigurationarn

---

containerRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-containerrecipearn

---

distributionConfigurationArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-distributionconfigurationarn

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-enhancedimagemetadataenabled

---

executionRole?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-executionrole

---

imageRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagerecipearn

---

imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

Contains settings for vulnerability scans.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagescanningconfiguration

---

imageTestsConfiguration?

Type: IResolvable | ImageTestsConfigurationProperty (optional)

The image tests configuration of the image.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-imagetestsconfiguration

---

tags?

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

The tags of the image.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-tags

---

workflows?

Type: IResolvable | IResolvable | WorkflowConfigurationProperty[] (optional)

Contains an array of workflow configuration objects.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-workflows