Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ContainerRecipeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ContainerRecipeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:50.022Z") @Stability(Experimental) public interface ContainerRecipeProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for creating a Container Recipe resource.

Example: 

 ContainerRecipe containerRecipe = ContainerRecipe.Builder.create(this, "MyContainerRecipe")
         .baseImage(BaseContainerImage.fromDockerHub("amazonlinux", "latest"))
         .targetRepository(Repository.fromEcr(Repository.fromRepositoryName(this, "Repository", "my-container-repo")))
         .build();
 ImagePipeline containerPipeline = ImagePipeline.Builder.create(this, "MyContainerPipeline")
         .recipe(exampleContainerRecipe)
         .build();

  • Method Details

    • getBaseImage

      @Stability(Experimental) @NotNull BaseContainerImage getBaseImage()
      (experimental) The base image for customizations specified in the container recipe.

    • getTargetRepository

      @Stability(Experimental) @NotNull Repository getTargetRepository()
      (experimental) The container repository where the output container image is stored.

    • getComponents

      @Stability(Experimental) @Nullable default List<ComponentConfiguration> getComponents()
      (experimental) The list of component configurations to apply in the image build.

      Default: None

    • getContainerRecipeName

      @Stability(Experimental) @Nullable default String getContainerRecipeName()
      (experimental) The name of the container recipe.

      Default: a name is generated

    • getContainerRecipeVersion

      @Stability(Experimental) @Nullable default String getContainerRecipeVersion()
      (experimental) The version of the container recipe.

      Default: 1.0.x

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) The description of the container recipe.

      Default: None

    • getDockerfile

      @Stability(Experimental) @Nullable default DockerfileData getDockerfile()
      (experimental) 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

    • getInstanceBlockDevices

      @Stability(Experimental) @Nullable default List<BlockDevice> getInstanceBlockDevices()
      (experimental) 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

    • getInstanceImage

      @Stability(Experimental) @Nullable default ContainerInstanceImage getInstanceImage()
      (experimental) 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

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) The KMS key used to encrypt the dockerfile template.

      Default: None

    • getOsVersion

      @Stability(Experimental) @Nullable default OSVersion getOsVersion()
      (experimental) 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.

    • getTags

      @Stability(Experimental) @Nullable default Map<String,String> getTags()
      (experimental) The tags to apply to the container recipe.

      Default: None

    • getWorkingDirectory

      @Stability(Experimental) @Nullable default String getWorkingDirectory()
      (experimental) 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:/

    • builder

      @Stability(Experimental) static ContainerRecipeProps.Builder builder()
      Returns:
      a ContainerRecipeProps.Builder of ContainerRecipeProps