AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ImageBuilder::ImageRecipe

CfnImageRecipe

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnImageRecipeProps.

nameRequired
string

The name of the image recipe.

parentImageRequired
string

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options: - AMI ID - Image Builder image Amazon Resource Name (ARN) - AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by `ssm:` , followed by the parameter name or ARN. - AWS Marketplace product ID

versionRequired
string

The semantic version of the image recipe. This version follows the semantic version syntax. > The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. > > *Assignment:* For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. > > *Patterns:* You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

additionalInstanceConfigurationOptional
IResolvable | AdditionalInstanceConfigurationProperty

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

amiTagsOptional
{ [key: string]: string } | IResolvable

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

blockDeviceMappingsOptional
IResolvable | IResolvable | InstanceBlockDeviceMappingProperty[]

The block device mappings to apply when creating images from this recipe.

componentsOptional
IResolvable | IResolvable | ComponentConfigurationProperty[]

The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

descriptionOptional
string

The description of the image recipe.

tagsOptional
{ [key: string]: string }

The tags of the image recipe.

workingDirectoryOptional
string

The working directory to be used during build and test workflows.

CloudFormation Resource

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

AWS::ImageBuilder::ImageRecipeView 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::ImageRecipe
Properties10

Related Constructs

Explore This Service

External Links