@aws-cdk/aws-imagebuilder-alpha.BaseImage

Experimental

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

BaseImage Class

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

Stability

Experimental

Source

lib/base-image.ts

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')
      }
    }
  ]
});

Properties

imagestringimagestrimageStringImagestringImage*stringrequired#

The rendered base image to use.

Methods

fromAmiId(amiId: string): BaseImage // chainable@staticmethod def from_ami_id(ami_id: str) -> BaseImagepublic static BaseImage fromAmiId(String amiId)public static BaseImage FromAmiId(string amiId)func FromAmiId(AmiId *string) BaseImagestatic#

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

1 parameter

Parameters

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

fromImage(image: IImage): BaseImage // chainable@staticmethod def from_image(image: IImage) -> BaseImagepublic static BaseImage fromImage(IImage image)public static BaseImage FromImage(IImage image)func FromImage(Image IImage) BaseImagestatic#

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

1 parameter

Parameters

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

fromMarketplaceProductId(productId: string): BaseImage // chainable@staticmethod def from_marketplace_product_id(product_id: str) -> BaseImagepublic static BaseImage fromMarketplaceProductId(String productId)public static BaseImage FromMarketplaceProductId(string productId)func FromMarketplaceProductId(ProductId *string) BaseImagestatic#

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

1 parameter

Parameters

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

fromSsmParameter(parameter: IParameter): BaseImage // chainable@staticmethod def from_ssm_parameter(parameter: IParameter) -> BaseImagepublic static BaseImage fromSsmParameter(IParameter parameter)public static BaseImage FromSsmParameter(IParameter parameter)func FromSsmParameter(Parameter IParameter) BaseImagestatic#

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

1 parameter

Parameters

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

fromSsmParameterName(parameterName: string): BaseImage // chainable@staticmethod def from_ssm_parameter_name(parameter_name: str) -> BaseImagepublic static BaseImage fromSsmParameterName(String parameterName)public static BaseImage FromSsmParameterName(string parameterName)func FromSsmParameterName(ParameterName *string) BaseImagestatic#

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

1 parameter

Parameters

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

fromString(baseImageString: string): BaseImage // chainable@staticmethod def from_string(base_image_string: str) -> BaseImagepublic static BaseImage fromString(String baseImageString)public static BaseImage FromString(string baseImageString)func FromString(BaseImageString *string) BaseImagestatic#

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.

1 parameter

Parameters

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