interface ContainerRecipeProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.ContainerRecipeProps
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ContainerRecipeProps
Java	software.amazon.awscdk.services.imagebuilder.alpha.ContainerRecipeProps
Python	aws_cdk.aws_imagebuilder_alpha.ContainerRecipeProps
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » ContainerRecipeProps

Properties for creating a Container Recipe resource.

Example

const containerRecipe = new imagebuilder.ContainerRecipe(this, 'MyContainerRecipe', {
  baseImage: imagebuilder.BaseContainerImage.fromDockerHub('amazonlinux', 'latest'),
  targetRepository: imagebuilder.Repository.fromEcr(
    ecr.Repository.fromRepositoryName(this, 'Repository', 'my-container-repo')
  )
});

const containerPipeline = new imagebuilder.ImagePipeline(this, 'MyContainerPipeline', {
  recipe: exampleContainerRecipe
});

Properties

Name	Type	Description
baseImage🔹	BaseContainerImage	The base image for customizations specified in the container recipe.
targetRepository🔹	Repository	The container repository where the output container image is stored.
components?🔹	ComponentConfiguration[]	The list of component configurations to apply in the image build.
containerRecipeName?🔹	string	The name of the container recipe.
containerRecipeVersion?🔹	string	The version of the container recipe.
description?🔹	string	The description of the container recipe.
dockerfile?🔹	DockerfileData	The dockerfile template used to build the container image.
instanceBlockDevices?🔹	BlockDevice[]	The block devices to attach to the instance used for building, testing, and distributing the container image.
instanceImage?🔹	ContainerInstanceImage	The image to use to launch the instance used for building, testing, and distributing the container image.
kmsKey?🔹	IKey	The KMS key used to encrypt the dockerfile template.
osVersion?🔹	OSVersion	The operating system (OS) version of the base image.
tags?🔹	{ [string]: string }	The tags to apply to the container recipe.
workingDirectory?🔹	string	The working directory for use during build and test workflows.

---

baseImage🔹

Type: BaseContainerImage

The base image for customizations specified in the container recipe.

---

targetRepository🔹

Type: Repository

The container repository where the output container image is stored.

---

components?🔹

Type: ComponentConfiguration[] (optional, default: None)

The list of component configurations to apply in the image build.

---

containerRecipeName?🔹

Type: string (optional, default: a name is generated)

The name of the container recipe.

---

containerRecipeVersion?🔹

Type: string (optional, default: 1.0.x)

The version of the container recipe.

---

description?🔹

Type: string (optional, default: None)

The description of the container recipe.

---

dockerfile?🔹

Type: DockerfileData (optional, default: a standard dockerfile template will be generated to pull the base image, perform environment setup, and run all components in the recipe)

The dockerfile template used to build the container image.

---

instanceBlockDevices?🔹

Type: BlockDevice[] (optional, default: the block devices of the instance image will be used)

The block devices to attach to the instance used for building, testing, and distributing the container image.

---

instanceImage?🔹

Type: ContainerInstanceImage (optional, default: Image Builder will use the appropriate ECS-optimized AMI)

The image to use to launch the instance used for building, testing, and distributing the container image.

---

kmsKey?🔹

Type: IKey (optional, default: None)

The KMS key used to encrypt the dockerfile template.

---

osVersion?🔹

Type: OSVersion (optional, default: Image Builder will determine the OS version of the base image, if sourced from a third-party container registry. Otherwise, the OS version of the base image is required.)

The operating system (OS) version of the base image.

---

tags?🔹

Type: { [string]: string } (optional, default: None)

The tags to apply to the container recipe.

---

workingDirectory?🔹

Type: string (optional, default: the Image Builder default working directory is used. For Linux and macOS builds, this would be /tmp. For Windows builds, this would be C:/)

The working directory for use during build and test workflows.