Addressed review comments

Author: Tarun Belani

packages/@aws-cdk/aws-imagebuilder-alpha/awslint.json

@@ -1,5 +1,6 @@
 {
   "exclude": [
-    "props-no-arn-refs:@aws-cdk/aws-imagebuilder-alpha.InfrastructureConfigurationProps.ec2InstanceHostResourceGroupArn"
+    "props-no-arn-refs:@aws-cdk/aws-imagebuilder-alpha.InfrastructureConfigurationProps.ec2InstanceHostResourceGroupArn",
+    "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.ContainerType"
   ]
 }

packages/@aws-cdk/aws-imagebuilder-alpha/lib/container-recipe.ts

@@ -22,6 +22,14 @@ const CONTAINER_RECIPE_SYMBOL = Symbol.for('@aws-cdk/aws-imagebuilder-alpha.Cont
  */
 const LATEST_VERSION = 'x.x.x';
 
+/**
+ * The default version to use in the container recipe. When the recipe is updated, the `x` will be incremented off from
+ * the latest recipe version that exists.
+ *
+ * @see https://docs.aws.amazon.com/imagebuilder/latest/userguide/create-image-recipes.html
+ */
+const DEFAULT_RECIPE_VERSION = '1.0.x';
+
 /**
  * An EC2 Image Builder Container Recipe.
  */
@@ -143,6 +151,16 @@ export interface ContainerRecipeProps {
   readonly tags?: { [key: string]: string };
 }
 
+/**
+ * The type of the container being used in the container recipe
+ */
+export enum ContainerType {
+  /**
+   * Indicates the container recipe uses a Docker container
+   */
+  DOCKER = 'DOCKER',
+}
+
 /**
  * The rendered Dockerfile value, for use in CloudFormation.
  * - For inline dockerfiles, dockerfileTemplateData is the Dockerfile template text
@@ -397,17 +415,13 @@ export class ContainerRecipe extends ContainerRecipeBase {
     id: string,
     attrs: ContainerRecipeAttributes,
   ): IContainerRecipe {
-    if (attrs.containerRecipeArn && (attrs.containerRecipeName || attrs.containerRecipeVersion)) {
+    if (!attrs.containerRecipeArn && !attrs.containerRecipeName) {
       throw new cdk.ValidationError(
-        'a containerRecipeName and containerRecipeVersion cannot be provided when a containerRecipeArn is provided',
+        'either either containerRecipeArn or containerRecipeName must be provided to import a container recipe',
         scope,
       );
     }
 
-    if (!attrs.containerRecipeArn && !attrs.containerRecipeName) {
-      throw new cdk.ValidationError('either containerRecipeArn or containerRecipeName is required', scope);
-    }
-
     const containerRecipeArn =
       attrs.containerRecipeArn ??
       cdk.Stack.of(scope).formatArn({
@@ -481,14 +495,17 @@ export class ContainerRecipe extends ContainerRecipeBase {
 
     this.validateContainerRecipeName();
 
-    this.addInstanceBlockDevices(...(props.instanceBlockDevices ?? []));
+    this.addInstanceBlockDevice(...(props.instanceBlockDevices ?? []));
 
     const components: CfnContainerRecipe.ComponentConfigurationProperty[] | undefined = props.components?.map(
       (component) => ({
         componentArn: component.component.componentArn,
-        ...(Object.keys(component.parameters ?? {}).length && {
-          parameters: Object.entries(component.parameters!).map(
-            ([key, value]): CfnContainerRecipe.ComponentParameterProperty => ({ name: key, value: value.value }),
+        ...(component.parameters && {
+          parameters: Object.entries(component.parameters).map(
+            ([name, param]): CfnContainerRecipe.ComponentParameterProperty => ({
+              name,
+              value: param.value,
+            }),
           ),
         }),
       }),
@@ -500,13 +517,13 @@ export class ContainerRecipe extends ContainerRecipeBase {
         'FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}',
       );
 
-    const containerRecipeVersion = props.containerRecipeVersion ?? '1.0.x';
+    const containerRecipeVersion = props.containerRecipeVersion ?? DEFAULT_RECIPE_VERSION;
     const containerRecipe = new CfnContainerRecipe(this, 'Resource', {
       name: this.physicalName,
       version: containerRecipeVersion,
       description: props.description,
       parentImage: props.baseImage.image,
-      containerType: 'DOCKER',
+      containerType: ContainerType.DOCKER,
       targetRepository: {
         repositoryName: props.targetRepository.repositoryName,
         service: props.targetRepository.service,
@@ -535,15 +552,15 @@ export class ContainerRecipe extends ContainerRecipeBase {
    *
    * @param instanceBlockDevices - The list of block devices to attach
    */
-  public addInstanceBlockDevices(...instanceBlockDevices: ec2.BlockDevice[]): void {
+  public addInstanceBlockDevice(...instanceBlockDevices: ec2.BlockDevice[]): void {
     this.instanceBlockDevices.push(...instanceBlockDevices);
   }
 
   /**
    * Renders the block devices provided as input to the construct, into the block device mapping structure that
    * CfnContainerRecipe expects to receive.
    *
-   * This is rendered at synthesis time, as users can add additional block devices with `addInstanceBlockDevices`, after
+   * This is rendered at synthesis time, as users can add additional block devices with `addInstanceBlockDevice`, after
    * the construct has been instantiated.
    *
    * @private
@@ -576,6 +593,13 @@ export class ContainerRecipe extends ContainerRecipeBase {
     return blockDevices.length ? blockDevices : undefined;
   }
 
+  /**
+   * Generates the instance configuration property into the `InstanceConfiguration` type in the  CloudFormation L1
+   * definition.
+   *
+   * @param props The props passed as input to the construct
+   * @private
+   */
   private buildInstanceConfiguration(
     props: ContainerRecipeProps,
   ): CfnContainerRecipe.InstanceConfigurationProperty | undefined {

packages/@aws-cdk/aws-imagebuilder-alpha/test/base-image.test.ts

@@ -3,7 +3,7 @@ import * as ecr from 'aws-cdk-lib/aws-ecr';
 import * as ssm from 'aws-cdk-lib/aws-ssm';
 import { BaseContainerImage, ContainerInstanceImage } from '../lib';
 
-describe('Base Image', () => {
+describe('Base Container Image', () => {
   let app: cdk.App;
   let stack: cdk.Stack;
 
@@ -36,6 +36,16 @@ describe('Base Image', () => {
     const baseImage = BaseContainerImage.fromString('base-image');
     expect(baseImage.image).toEqual('base-image');
   });
+});
+
+describe('Container Instance Image', () => {
+  let app: cdk.App;
+  let stack: cdk.Stack;
+
+  beforeEach(() => {
+    app = new cdk.App();
+    stack = new cdk.Stack(app, 'Stack', { env: { region: 'us-east-1', account: '123456789012' } });
+  });
 
   test('should return the correct container instance image for an AMI ID', () => {
     const containerInstanceImage = ContainerInstanceImage.fromAmiId('ami-12345678');

packages/@aws-cdk/aws-imagebuilder-alpha/test/container-recipe.test.ts

@@ -199,7 +199,7 @@ CMD ["echo", "Hello, world!"]
       },
     });
 
-    containerRecipe.addInstanceBlockDevices(
+    containerRecipe.addInstanceBlockDevice(
       {
         deviceName: '/dev/sda2',
         volume: ec2.BlockDeviceVolume.ebs(75, {
@@ -601,14 +601,14 @@ CMD ["echo", "Hello, world!"]
     });
   });
 
-  test('throws a validation error when an containerRecipeArn and containerRecipeName are provided when importing by attributes', () => {
+  test('does not throw a validation error when a containerRecipeArn and containerRecipeName are provided when importing by attributes', () => {
     expect(() =>
       ContainerRecipe.fromContainerRecipeAttributes(stack, 'ContainerRecipe', {
         containerRecipeArn:
           'arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/imported-container-recipe/x.x.x',
         containerRecipeName: 'imported-container-recipe',
       }),
-    ).toThrow(cdk.ValidationError);
+    ).not.toThrow(cdk.ValidationError);
   });
 
   test('throws a validation error when neither a containerRecipeArn or containerRecipeName are provided when importing by attributes', () => {

packages/@aws-cdk/aws-imagebuilder-alpha/test/integ.all-parameters.container-recipe.js.snapshot/aws-cdk-imagebuilder-container-recipe-all-parameters.assets.json

@@ -97,6 +97,16 @@
    }
   }
  },
+ "Outputs": {
+  "ContainerRecipeVersion": {
+   "Value": {
+    "Fn::GetAtt": [
+     "ContainerRecipe8A7CC9ED",
+     "Version"
+    ]
+   }
+  }
+ },
  "Parameters": {
   "BootstrapVersion": {
    "Type": "AWS::SSM::Parameter::Value<String>",