feat(imagebuilder-alpha): add support for Image Recipe Construct

Author: Tarun Belani

packages/@aws-cdk/aws-imagebuilder-alpha/README.md

@@ -36,6 +36,200 @@ EC2 Image Builder supports AWS-managed components for common tasks, AWS Marketpl
 that you create. Components run during specific workflow phases: build and validate phases during the build stage, and
 test phase during the test stage.
 
+### Image Recipe
+
+An image recipe is a document that defines the base AMI and the components applied to produce the desired configuration
+for the output AMI. You can use image recipes to duplicate builds and maintain versioned, shareable configurations.
+Image recipes specify the base image, build components for customization, test components for validation, as well as
+other customizations to make to the output image, such as the block devices associated with the output AMI.
+
+#### Image Recipe Basic Usage
+
+Create an image recipe with the required base image:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'MyImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  )
+});
+```
+
+#### Image Recipe Base Images
+
+##### SSM Parameters
+
+Using SSM parameter references:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'SsmImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  )
+});
+
+// Using an SSM parameter construct
+const parameter = ssm.StringParameter.fromStringParameterName(
+  this,
+  'BaseImageParameter',
+  '/aws/service/ami-windows-latest/Windows_Server-2022-English-Full-Base'
+);
+const windowsRecipe = new imagebuilder.ImageRecipe(this, 'WindowsImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameter(parameter)
+});
+```
+
+##### AMI IDs
+
+When you have a specific AMI to use:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'AmiImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromAmiId('ami-12345678')
+});
+```
+
+##### Marketplace Images
+
+For marketplace base images:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'MarketplaceImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromMarketplaceProductId('prod-1234567890abcdef0')
+});
+```
+
+#### Image Recipe Components
+
+##### Custom Components in Image Recipes
+
+Add your own components to the recipe:
+
+```ts
+const customComponent = new imagebuilder.Component(this, 'MyComponent', {
+  platform: imagebuilder.Platform.LINUX,
+  data: imagebuilder.ComponentData.fromJsonObject({
+    schemaVersion: imagebuilder.ComponentSchemaVersion.V1_0,
+    phases: [
+      {
+        name: imagebuilder.ComponentPhaseName.BUILD,
+        steps: [
+          {
+            name: 'install-app',
+            action: imagebuilder.ComponentAction.EXECUTE_BASH,
+            inputs: {
+              commands: ['yum install -y my-application']
+            }
+          }
+        ]
+      }
+    ]
+  })
+});
+
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'ComponentImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  ),
+  components: [
+    {
+      component: customComponent
+    }
+  ]
+});
+```
+
+##### AWS-Managed Components in Image Recipes
+
+Use pre-built AWS components:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'AwsManagedImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  ),
+  components: [
+    {
+      component: imagebuilder.AwsManagedComponent.updateOS(this, 'UpdateOS', {
+        platform: imagebuilder.Platform.LINUX
+      })
+    },
+    {
+      component: imagebuilder.AwsManagedComponent.awsCliV2(this, 'AwsCli', {
+        platform: imagebuilder.Platform.LINUX
+      })
+    }
+  ]
+});
+```
+
+##### Component Parameters in Image Recipes
+
+Pass parameters to components that accept them:
+
+```ts
+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')
+      }
+    }
+  ]
+});
+```
+
+#### Image Recipe Configuration
+
+##### Block Device Configuration
+
+Configure storage for the build instance:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'BlockDeviceImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  ),
+  blockDevices: [
+    {
+      deviceName: '/dev/sda1',
+      volume: ec2.BlockDeviceVolume.ebs(100, {
+        encrypted: true,
+        volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3
+      })
+    }
+  ]
+});
+```
+
+##### AMI Tagging
+
+Tag the output AMI:
+
+```ts
+const imageRecipe = new imagebuilder.ImageRecipe(this, 'TaggedImageRecipe', {
+  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
+    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
+  ),
+  amiTags: {
+    Environment: 'Production',
+    Application: 'WebServer',
+    Owner: 'DevOps Team'
+  }
+});
+```
+
 ### Component
 
 A component defines the sequence of steps required to customize an instance during image creation (build component) or

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

@@ -0,0 +1,71 @@
+import * as ssm from 'aws-cdk-lib/aws-ssm';
+
+/**
+ * Represents a base image that is used to start from in EC2 Image Builder image builds
+ */
+export class BaseImage {
+  /**
+   * The AMI ID to use as a base image in an image recipe
+   *
+   * @param amiId The AMI ID to use as the base image
+   */
+  public static fromAmiId(amiId: string): BaseImage {
+    return new BaseImage(amiId);
+  }
+
+  /**
+   * TODO: Uncomment once the Image construct is implemented
+   *
+   * The EC2 Image Builder image to use as the base image in an image recipe
+   *
+   * @param image The EC2 Image Builder image to use as the base image
+   */
+  // public static fromImage(image: IImage): BaseImage {
+  //   return new BaseImage(image.imageArn);
+  // }
+
+  /**
+   * The marketplace product ID for an AMI product to use as the base image in an image recipe
+   *
+   * @param productId The Marketplace AMI product ID to use as the base image
+   */
+  public static fromMarketplaceProductId(productId: string): BaseImage {
+    return new BaseImage(productId);
+  }
+
+  /**
+   * The SSM parameter to use as the base image in an image recipe
+   *
+   * @param parameter The SSM parameter to use as the base image
+   */
+  public static fromSsmParameter(parameter: ssm.IStringParameter): BaseImage {
+    return this.fromSsmParameterName(parameter.parameterName);
+  }
+
+  /**
+   * The parameter name for the SSM parameter to use as the base image in an image recipe
+   *
+   * @param parameterName The name of the SSM parameter to use as the base image
+   */
+  public static fromSsmParameterName(parameterName: string): BaseImage {
+    return new BaseImage(`ssm:${parameterName}`);
+  }
+
+  /**
+   * The string value of the base image to use in an image recipe
+   *
+   * @param string The base image as a direct string value
+   */
+  public static fromString(string: string): BaseImage {
+    return new BaseImage(string);
+  }
+
+  /**
+   * The rendered base image to use
+   **/
+  public readonly image: string;
+
+  protected constructor(image: string) {
+    this.image = image;
+  }
+}