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

Class BaseImage

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.imagebuilder.alpha.BaseImage
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:50.010Z") @Stability(Experimental) public class BaseImage extends software.amazon.jsii.JsiiObject
(experimental) Represents a base image that is used to start from in EC2 Image Builder image builds.

Example: 

 IComponent parameterizedComponent = Component.fromComponentName(this, "ParameterizedComponent", "my-parameterized-component");
 ImageRecipe imageRecipe = ImageRecipe.Builder.create(this, "ParameterizedImageRecipe")
         .baseImage(BaseImage.fromSsmParameterName("/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64"))
         .components(List.of(ComponentConfiguration.builder()
                 .component(parameterizedComponent)
                 .parameters(Map.of(
                         "environment", ComponentParameterValue.fromString("production"),
                         "version", ComponentParameterValue.fromString("1.0.0")))
                 .build()))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    BaseImage(String image)
     
    protected
    BaseImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    BaseImage(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static BaseImage
    fromAmiId(String amiId)
    (experimental) The AMI ID to use as a base image in an image recipe.
    static BaseImage
    fromImage(IImage image)
    (experimental) The EC2 Image Builder image to use as a base image in an image recipe.
    static BaseImage
    fromMarketplaceProductId(String productId)
    (experimental) The marketplace product ID for an AMI product to use as the base image in an image recipe.
    static BaseImage
    fromSsmParameter(IParameter parameter)
    (experimental) The SSM parameter to use as the base image in an image recipe.
    static BaseImage
    fromSsmParameterName(String parameterName)
    (experimental) The parameter name for the SSM parameter to use as the base image in an image recipe.
    static BaseImage
    fromString(String baseImageString)
    (experimental) The direct string value of the base image to use in an image recipe.
    String
    getImage()
    (experimental) The rendered base image to use.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • BaseImage

      protected BaseImage(software.amazon.jsii.JsiiObjectRef objRef)

    • BaseImage

      protected BaseImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • BaseImage

      @Stability(Experimental) protected BaseImage(@NotNull String image)
      Parameters:
      image - This parameter is required.

  • Method Details

    • fromAmiId

      @Stability(Experimental) @NotNull public static BaseImage fromAmiId(@NotNull String amiId)
      (experimental) The AMI ID to use as a base image in an image recipe.

      Parameters:
      amiId - The AMI ID to use as the base image. This parameter is required.

    • fromImage

      @Stability(Experimental) @NotNull public static BaseImage fromImage(@NotNull IImage image)
      (experimental) The EC2 Image Builder image to use as a base image in an image recipe.

      Parameters:
      image - The EC2 Image Builder image to use as a base image. This parameter is required.

    • fromMarketplaceProductId

      @Stability(Experimental) @NotNull public static BaseImage fromMarketplaceProductId(@NotNull String productId)
      (experimental) The marketplace product ID for an AMI product to use as the base image in an image recipe.

      Parameters:
      productId - The Marketplace AMI product ID to use as the base image. This parameter is required.

    • fromSsmParameter

      @Stability(Experimental) @NotNull public static BaseImage fromSsmParameter(@NotNull IParameter parameter)
      (experimental) The SSM parameter to use as the base image in an image recipe.

      Parameters:
      parameter - The SSM parameter to use as the base image. This parameter is required.

    • fromSsmParameterName

      @Stability(Experimental) @NotNull public static BaseImage fromSsmParameterName(@NotNull String parameterName)
      (experimental) The parameter name for the SSM parameter to use as the base image in an image recipe.

      Parameters:
      parameterName - The name of the SSM parameter to use as the base image. This parameter is required.

    • fromString

      @Stability(Experimental) @NotNull public static BaseImage fromString(@NotNull String baseImageString)
      (experimental) The direct string value of the base image to use in an image recipe.

      This can be an EC2 Image Builder image ARN, an SSM parameter, an AWS Marketplace product ID, or an AMI ID.

      Parameters:
      baseImageString - The base image as a direct string value. This parameter is required.

    • getImage

      @Stability(Experimental) @NotNull public String getImage()
      (experimental) The rendered base image to use.