class BaseImage 🔹

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

Represents a base image that is used to start from in EC2 Image Builder image builds.

Example

const parameterizedComponent = imagebuilder.Component.fromComponentName(
  this,
  'ParameterizedComponent',
  'my-parameterized-component'
);

const imageRecipe = new imagebuilder.ImageRecipe(this, 'ParameterizedImageRecipe', {
  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
  ),
  components: [
    {
      component: parameterizedComponent,
      parameters: {
        environment: imagebuilder.ComponentParameterValue.fromString('production'),
        version: imagebuilder.ComponentParameterValue.fromString('1.0.0')
      }
    }
  ]
});

Initializer (protected)

super(image: string)

Parameters

• image string

Properties

Name	Type	Description
image🔹	string	The rendered base image to use.

---

image🔹

Type: string

The rendered base image to use.

Methods

Name	Description
static fromAmiId(amiId)🔹	The AMI ID to use as a base image in an image recipe.
static fromImage(image)🔹	The EC2 Image Builder image to use as a base image in an image recipe.
static fromMarketplaceProductId(productId)🔹	The marketplace product ID for an AMI product to use as the base image in an image recipe.
static fromSsmParameter(parameter)🔹	The SSM parameter to use as the base image in an image recipe.
static fromSsmParameterName(parameterName)🔹	The parameter name for the SSM parameter to use as the base image in an image recipe.
static fromString(baseImageString)🔹	The direct string value of the base image to use in an image recipe.

---

static fromAmiId(amiId)🔹

public static fromAmiId(amiId: string): BaseImage

Parameters

• amiId string — The AMI ID to use as the base image.

Returns

• BaseImage

The AMI ID to use as a base image in an image recipe.

---

static fromImage(image)🔹

public static fromImage(image: IImage): BaseImage

Parameters

• image IImage — The EC2 Image Builder image to use as a base image.

Returns

• BaseImage

The EC2 Image Builder image to use as a base image in an image recipe.

---

static fromMarketplaceProductId(productId)🔹

public static fromMarketplaceProductId(productId: string): BaseImage

Parameters

• productId string — The Marketplace AMI product ID to use as the base image.

Returns

• BaseImage

The marketplace product ID for an AMI product to use as the base image in an image recipe.

---

static fromSsmParameter(parameter)🔹

public static fromSsmParameter(parameter: IParameter): BaseImage

Parameters

• parameter IParameter — The SSM parameter to use as the base image.

Returns

• BaseImage

The SSM parameter to use as the base image in an image recipe.

---

static fromSsmParameterName(parameterName)🔹

public static fromSsmParameterName(parameterName: string): BaseImage

Parameters

• parameterName string — The name of the SSM parameter to use as the base image.

Returns

• BaseImage

The parameter name for the SSM parameter to use as the base image in an image recipe.

---

static fromString(baseImageString)🔹

public static fromString(baseImageString: string): BaseImage

Parameters

• baseImageString string — The base image as a direct string value.

Returns

• BaseImage

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.