AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ContainerRecipeProps Struct ​

Properties for creating a Container Recipe resource.

Stability
Experimental
Source
lib/container-recipe.ts

Example ​

ts
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 ​

baseImageBaseContainerImagebase_imageBaseContainerImagebaseImageBaseContainerImageBaseImageBaseContainerImageBaseImageBaseContainerImagerequired#
The base image for customizations specified in the container recipe.
componentsComponentConfiguration[]componentstyping.List[ComponentConfiguration]componentsList<ComponentConfiguration>ComponentsComponentConfiguration[]Components*[]ComponentConfiguration= None#
The list of component configurations to apply in the image build.
containerRecipeNamestringcontainer_recipe_namestrcontainerRecipeNameStringContainerRecipeNamestringContainerRecipeName*string#
The name of the container recipe.

Default: a name is generated

containerRecipeVersionstringcontainer_recipe_versionstrcontainerRecipeVersionStringContainerRecipeVersionstringContainerRecipeVersion*string= 1.0.x#
The version of the container recipe.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= None#
The description of the container recipe.
dockerfileDockerfileDatadockerfileDockerfileDatadockerfileDockerfileDataDockerfileDockerfileDataDockerfileDockerfileData#
The dockerfile template used to build the container image.

Default: a standard dockerfile template will be generated to pull the base image, perform environment setup, and run all components in the recipe

instanceBlockDevicesBlockDevice[]instance_block_devicestyping.List[BlockDevice]instanceBlockDevicesList<BlockDevice>InstanceBlockDevicesBlockDevice[]InstanceBlockDevices*[]BlockDevice#
The block devices to attach to the instance used for building, testing, and distributing the container image.

Default: the block devices of the instance image will be used

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

Default: Image Builder will use the appropriate ECS-optimized AMI

kmsKeyIKeykms_keyIKeykmsKeyIKeyKmsKeyIKeyKmsKeyIKey= None#
The KMS key used to encrypt the dockerfile template.
osVersionOSVersionos_versionOSVersionosVersionOSVersionOsVersionOSVersionOsVersionOSVersion#
The operating system (OS) version of the base image.

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.

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= None#
The tags to apply to the container recipe.
targetRepositoryRepositorytarget_repositoryRepositorytargetRepositoryRepositoryTargetRepositoryRepositoryTargetRepositoryRepositoryrequired#
The container repository where the output container image is stored.
workingDirectorystringworking_directorystrworkingDirectoryStringWorkingDirectorystringWorkingDirectory*string#
The working directory for use during build and test workflows.

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:/