Addressed review comments

Author: Tarun Belani

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

@@ -76,7 +76,7 @@ export class ContainerInstanceImage {
    * @param parameter The SSM parameter to use as the container instance image
    */
   public static fromSsmParameter(parameter: ssm.IStringParameter): ContainerInstanceImage {
-    return this.fromSsmParameterName(parameter.parameterArn);
+    return new ContainerInstanceImage(`ssm:${parameter.parameterArn}`);
   }
 
   /**
@@ -89,8 +89,9 @@ export class ContainerInstanceImage {
   }
 
   /**
-   * The string value of the container instance image to use in a container recipe. This can either be an SSM parameter,
-   * or an AMI ID.
+   * The string value of the container instance image to use in a container recipe. This can either be:
+   * - an SSM parameter reference, prefixed with `ssm:` and followed by the parameter name or ARN
+   * - an AMI ID
    *
    * @param containerInstanceImageString The container instance image as a direct string value
    */

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

@@ -14,6 +14,12 @@ import { ComponentConfiguration, IRecipeBase } from './recipe-base';
 
 const CONTAINER_RECIPE_SYMBOL = Symbol.for('@aws-cdk/aws-imagebuilder-alpha.ContainerRecipe');
 
+/**
+ * Represents the latest version of a container recipe. When using the recipe in a pipeline, the pipeline will use the
+ * latest recipe at the time of execution.
+ *
+ * @see https://docs.aws.amazon.com/imagebuilder/latest/userguide/ibhow-semantic-versioning.html
+ */
 const LATEST_VERSION = 'x.x.x';
 
 /**
@@ -66,7 +72,7 @@ export interface ContainerRecipeProps {
   /**
    * The version of the container recipe.
    *
-   * @default 1.0.0
+   * @default 1.0.x
    */
   readonly containerRecipeVersion?: string;
 
@@ -81,7 +87,7 @@ export interface ContainerRecipeProps {
    * 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
+   * run all components in the recipe
    */
   readonly dockerfile?: DockerfileData;
 
@@ -103,15 +109,15 @@ export interface ContainerRecipeProps {
    * 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:/
+   * Windows builds, this would be C:/
    */
   readonly workingDirectory?: string;
 
   /**
    * 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.
+   * registry. Otherwise, the OS version of the base image is required.
    */
   readonly osVersion?: OSVersion;
 
@@ -137,6 +143,27 @@ export interface ContainerRecipeProps {
   readonly tags?: { [key: string]: string };
 }
 
+/**
+ * The rendered Dockerfile value, for use in CloudFormation.
+ * - For inline dockerfiles, dockerfileTemplateData is the Dockerfile template text
+ * - For S3-backed dockerfiles, dockerfileTemplateUri is the S3 URL
+ */
+export interface DockerfileTemplateConfig {
+  /**
+   * The rendered Dockerfile data, for use in CloudFormation
+   *
+   * @default - none if dockerfileTemplateUri is set
+   */
+  readonly dockerfileTemplateData?: string;
+
+  /**
+   * The rendered Dockerfile URI, for use in CloudFormation
+   *
+   * @default - none if dockerfileTemplateData is set
+   */
+  readonly dockerfileTemplateUri?: string;
+}
+
 /**
  * Helper class for referencing and uploading dockerfile data for the container recipe
  */
@@ -179,36 +206,34 @@ export abstract class DockerfileData {
   }
 
   /**
-   * Indicates that the provided dockerfile data is an S3 reference
-   */
-  abstract readonly isS3Reference: boolean;
-
-  /**
-   * The resulting inline string or S3 URL which references the dockerfile data
+   * The rendered Dockerfile value, for use in CloudFormation.
+   * - For inline dockerfiles, dockerfileTemplateData is the Dockerfile template text
+   * - For S3-backed dockerfiles, dockerfileTemplateUri is the S3 URL
    */
-  public readonly value: string;
-
-  protected constructor(value: string) {
-    this.value = value;
-  }
+  abstract render(): DockerfileTemplateConfig;
 }
 
 /**
  * Helper class for S3-based dockerfile data references, containing additional permission grant methods on the S3 object
  */
 export abstract class S3DockerfileData extends DockerfileData {
-  public readonly isS3Reference = true;
-
   protected readonly bucket: s3.IBucket;
   protected readonly key: string;
 
   protected constructor(bucket: s3.IBucket, key: string) {
-    super(bucket.s3UrlForObject(key));
+    super();
 
     this.bucket = bucket;
     this.key = key;
   }
 
+  /**
+   * The rendered Dockerfile S3 URL, for use in CloudFormation
+   */
+  public render(): DockerfileTemplateConfig {
+    return { dockerfileTemplateUri: this.bucket.s3UrlForObject(this.key) };
+  }
+
   /**
    * Grant put permissions to the given grantee for the dockerfile data in S3
    *
@@ -229,10 +254,19 @@ export abstract class S3DockerfileData extends DockerfileData {
 }
 
 class InlineDockerfileData extends DockerfileData {
-  public readonly isS3Reference = false;
+  protected readonly data: string;
 
   public constructor(data: string) {
-    super(data);
+    super();
+
+    this.data = data;
+  }
+
+  /**
+   * The rendered Dockerfile text, for use in CloudFormation
+   */
+  public render(): DockerfileTemplateConfig {
+    return { dockerfileTemplateData: this.data };
   }
 }
 
@@ -255,24 +289,22 @@ export interface ContainerRecipeAttributes {
   /**
    * The ARN of the container recipe
    *
-   * @default - the ARN is automatically constructed if a containerRecipeName is provided, otherwise a
-   *            containerRecipeArn is required
+   * @default - derived from containerRecipeName
    */
   readonly containerRecipeArn?: string;
 
   /**
    * The name of the container recipe
    *
-   * @default - the name is automatically constructed if a containerRecipeArn is provided, otherwise a
-   *            containerRecipeName is required
+   * @default - derived from containerRecipeArn
    */
   readonly containerRecipeName?: string;
 
   /**
    * The version of the container recipe
    *
-   * @default - the version is automatically constructed if a containerRecipeArn is provided, otherwise the latest
-   *            version is used.
+   * @default - derived from containerRecipeArn. if a containerRecipeName is provided, the latest version, x.x.x, will
+   * be used.
    */
   readonly containerRecipeVersion?: string;
 }
@@ -468,7 +500,7 @@ export class ContainerRecipe extends ContainerRecipeBase {
         'FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}',
       );
 
-    const containerRecipeVersion = props.containerRecipeVersion ?? '1.0.0';
+    const containerRecipeVersion = props.containerRecipeVersion ?? '1.0.x';
     const containerRecipe = new CfnContainerRecipe(this, 'Resource', {
       name: this.physicalName,
       version: containerRecipeVersion,
@@ -485,10 +517,8 @@ export class ContainerRecipe extends ContainerRecipeBase {
       instanceConfiguration: cdk.Lazy.any({ produce: () => this.buildInstanceConfiguration(props) }),
       workingDirectory: props.workingDirectory,
       tags: props.tags,
+      ...dockerfile.render(),
       ...(components?.length && { components }),
-      ...(dockerfile.isS3Reference
-        ? { dockerfileTemplateUri: dockerfile.value }
-        : { dockerfileTemplateData: dockerfile.value }),
     });
 
     this.containerRecipeName = this.getResourceNameAttribute(containerRecipe.attrName);
@@ -499,6 +529,7 @@ export class ContainerRecipe extends ContainerRecipeBase {
     });
     this.containerRecipeVersion = containerRecipe.getAtt('Version').toString();
   }
+
   /**
    * Adds block devices to attach to the instance used for building, testing, and distributing the container image.
    *

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

@@ -345,7 +345,7 @@ CMD ["echo", "Hello, world!"]
           Type: 'AWS::ImageBuilder::ContainerRecipe',
           Properties: {
             Name: 'stack-containerrecipe-fcc21fd4',
-            Version: '1.0.0',
+            Version: '1.0.x',
             ContainerType: 'DOCKER',
             ParentImage: 'amazonlinux:latest',
             DockerfileTemplateData:
@@ -373,7 +373,7 @@ CMD ["echo", "Hello, world!"]
           Type: 'AWS::ImageBuilder::ContainerRecipe',
           Properties: {
             Name: 'stack-containerrecipe-fcc21fd4',
-            Version: '1.0.0',
+            Version: '1.0.x',
             ContainerType: 'DOCKER',
             ParentImage: 'amazonlinux:latest',
             DockerfileTemplateUri:
@@ -402,7 +402,7 @@ CMD ["echo", "Hello, world!"]
           Type: 'AWS::ImageBuilder::ContainerRecipe',
           Properties: {
             Name: 'stack-containerrecipe-fcc21fd4',
-            Version: '1.0.0',
+            Version: '1.0.x',
             ContainerType: 'DOCKER',
             ParentImage: 'amazonlinux:latest',
             DockerfileTemplateUri: 's3://dockerfile-bucket-123456789012-us-east-1/dockerfile/Dockerfile',

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

@@ -32,9 +32,9 @@ const parameterizedComponent = new imagebuilder.Component(stack, 'ParameterizedC
           {
             name: 'step1',
             action: imagebuilder.ComponentAction.EXECUTE_BASH,
-            inputs: {
+            inputs: imagebuilder.ComponentStepInputs.fromObject({
               commands: ['echo ${{ parameter1 }}', 'echo ${{ parameter2 }}'],
-            },
+            }),
           },
         ],
       },

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

@@ -29,7 +29,7 @@
      },
      "Service": "ECR"
     },
-    "Version": "1.0.0"
+    "Version": "1.0.x"
    }
   }
  },