AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ImageBuilder::Image

CfnImage

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnImageProps.

containerRecipeArnOptional
string

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

deletionSettingsOptional
IResolvable | DeletionSettingsProperty

Enables deletion of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

distributionConfigurationArnOptional
string | IDistributionConfigurationRef

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your 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.

imagePipelineExecutionSettingsOptional
IResolvable | ImagePipelineExecutionSettingsProperty

The image pipeline execution settings of the image.

imageRecipeArnOptional
string | IImageRecipeRef

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

imageScanningConfigurationOptional
IResolvable | ImageScanningConfigurationProperty

Contains settings for vulnerability scans.

imageTestsConfigurationOptional
IResolvable | ImageTestsConfigurationProperty

The image tests configuration of the image.

infrastructureConfigurationArnOptional
string | IInfrastructureConfigurationRef

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

loggingConfigurationOptional
IResolvable | ImageLoggingConfigurationProperty

The logging configuration that's defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.

tagsOptional
{ [key: string]: string }

The tags of the image.

workflowsOptional
IResolvable | IResolvable | WorkflowConfigurationProperty[]

Contains an array of workflow configuration objects.

CloudFormation Resource

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

AWS::ImageBuilder::ImageView 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::Image
Properties13

Related Constructs

Explore This Service

External Links