Merge pull request #77 from dannysteenman/main

fix: improve components props

Author: cmagee

API.md

@@ -47,9 +47,18 @@ import { Construct } from 'constructs';
 // ...
 // Create a new image pipeline with the required properties
 new ImagePipeline(this, "MyImagePipeline", {
-    componentDocuments: ['component_example.yml', 'component_example_2.yml'],
-    componentNames: ['Component', 'Component2'],
-    componentVersions: ['0.0.1', '0.1.0'],
+    components: [
+      {
+        document: 'component_example.yml',
+        name: 'Component',
+        version: '0.0.1',
+      },
+      {
+        document: 'component_example_2.yml',
+        name: 'Component2',
+        version: '0.1.0',
+      },
+    ],
     kmsKeyAlias: 'alias/my-key',
     profileName: 'ImagePipelineInstanceProfile',
     infraConfigName: 'MyInfrastructureConfiguration',
@@ -96,9 +105,18 @@ const private_subnet = vpc.privateSubnets;
 
 
 new ImagePipeline(this, "MyImagePipeline", {
-    componentDocuments: ['component_example.yml', 'component_example_2.yml'],
-    componentNames: ['Component', 'Component2'],
-    componentVersions: ['0.0.1', '0.1.0'],
+    components: [
+      {
+        document: 'component_example.yml',
+        name: 'Component',
+        version: '0.0.1',
+      },
+      {
+        document: 'component_example_2.yml',
+        name: 'Component2',
+        version: '0.1.0',
+      },
+    ],
     kmsKeyAlias: 'alias/my-key',
     profileName: 'ImagePipelineInstanceProfile',
     infraConfigName: 'MyInfrastructureConfiguration',
@@ -121,9 +139,18 @@ from constructs import Construct
 image_pipeline = ImagePipeline(
     self,
     "LatestImagePipeline",
-    component_documents=["component_example.yml", "component_example2.yml"],
-    component_names=["Component", "Component2"],
-    component_versions=["0.0.1", "0.1.0"],
+    components=[
+      {
+        document: 'component_example.yml',
+        name: 'Component',
+        version: '0.0.1',
+      },
+      {
+        document: 'component_example_2.yml',
+        name: 'Component2',
+        version: '0.1.0',
+      },
+    ],
     kms_key_alias="alias/my-key",
     image_recipe="Recipe4",
     pipeline_name="Pipeline4",
@@ -172,9 +199,18 @@ priv_subnets = vpc.private_subnets
 image_pipeline = ImagePipeline(
     self,
     "LatestImagePipeline",
-    component_documents=["component_example.yml", "component_example2.yml"],
-    component_names=["Component", "Component2"],
-    component_versions=["0.0.1", "0.1.0"],
+    components=[
+      {
+        document: 'component_example.yml',
+        name: 'Component',
+        version: '0.0.1',
+      },
+      {
+        document: 'component_example_2.yml',
+        name: 'Component2',
+        version: '0.1.0',
+      },
+    ],
     kms_key_alias="alias/my-key",
     image_recipe="Recipe4",
     pipeline_name="Pipeline4",

README.md

@@ -11,19 +11,26 @@ import {
 import { SnsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
 import { Construct } from 'constructs';
 
-export interface ImagePipelineProps {
+export interface ComponentProps {
   /**
-   * Relative path to Image Builder component documents
+   * Relative path to Image Builder component document
    */
-  readonly componentDocuments: string[];
+  readonly document: string;
   /**
-   * Names of the Component Documents
+   * Name of the Component Document
    */
-  readonly componentNames: string[];
+  readonly name: string;
   /**
-   * Versions for each component document
+   * Version for each component document
    */
-  readonly componentVersions: string[];
+  readonly version: string;
+}
+
+export interface ImagePipelineProps {
+  /**
+   * List of component props
+   */
+  readonly components: ComponentProps[];
   /**
    * Name of the instance profile that will be associated with the Instance Configuration.
    */
@@ -130,6 +137,7 @@ export interface ImagePipelineProps {
 
 export class ImagePipeline extends Construct {
   imageRecipeComponents: imagebuilder.CfnImageRecipe.ComponentConfigurationProperty[];
+
   constructor(scope: Construct, id: string, props: ImagePipelineProps) {
     super(scope, id);
     let infrastructureConfig: imagebuilder.CfnInfrastructureConfiguration;
@@ -140,6 +148,7 @@ export class ImagePipeline extends Construct {
     const kmsKey = kms.Key.fromLookup(this, 'KmsKeyLookup', {
       aliasName: props.kmsKeyAlias,
     });
+
     const topic = new sns.Topic(this, 'ImageBuilderTopic', {
       displayName: 'Image Builder Notify',
       masterKey: kmsKey,
@@ -219,16 +228,16 @@ export class ImagePipeline extends Construct {
     }
     imageRecipe = new imagebuilder.CfnImageRecipe(this, 'ImageRecipe', imageRecipeProps);
 
-    props.componentDocuments.forEach((document, index) => {
-      let component = new imagebuilder.CfnComponent(this, props.componentNames[index], {
-        name: props.componentNames[index],
-        platform: props.platform ?? 'Linux',
-        version: props.componentVersions[index] ?? '0.0.1',
-        data: readFileSync(document).toString(),
+    props.components.forEach((component) => {
+      let newComponent = new imagebuilder.CfnComponent(this, component.name, {
+        name: component.name,
+        platform: 'Linux',
+        version: component.version,
+        data: readFileSync(component.document).toString(),
       });
 
       // add the component to the Image Recipe
-      this.imageRecipeComponents.push({ componentArn: component.attrArn });
+      this.imageRecipeComponents.push({ componentArn: newComponent.attrArn });
       imageRecipe.components = this.imageRecipeComponents;
     });
 
@@ -322,4 +331,4 @@ export class ImagePipeline extends Construct {
     }
     new imagebuilder.CfnImagePipeline(this, 'ImagePipeline', imagePipelineProps);
   }
-}
+}

src/index.ts

@@ -5,9 +5,18 @@ import { ImagePipeline, ImagePipelineProps } from '../src';
 let template: Template;
 
 const props: ImagePipelineProps = {
-  componentDocuments: ['test/test_component_example.yml', 'test/test_component_example_2.yml'],
-  componentNames: ['TestComponent', 'TestComponent2'],
-  componentVersions: ['1.0.0'],
+  components: [
+    {
+      document: 'test/test_component_example.yml',
+      name: 'TestComponent',
+      version: '1.0.0',
+    },
+    {
+      document: 'test/test_component_example_2.yml',
+      name: 'TestComponent2',
+      version: '1.0.0',
+    },
+  ],
   profileName: 'TestProfile',
   infraConfigName: 'TestInfrastructureConfig',
   imageRecipe: 'TestImageRecipe',
@@ -24,9 +33,13 @@ const props: ImagePipelineProps = {
 };
 
 const propsWithNetworking: ImagePipelineProps = {
-  componentDocuments: ['test/test_component_example.yml'],
-  componentNames: ['TestComponent'],
-  componentVersions: ['1.0.0'],
+  components: [
+    {
+      document: 'test/test_component_example.yml',
+      name: 'TestComponent',
+      version: '1.0.0',
+    },
+  ],
   profileName: 'TestProfile',
   infraConfigName: 'TestInfrastructureConfig',
   imageRecipe: 'TestImageRecipe',
@@ -38,9 +51,13 @@ const propsWithNetworking: ImagePipelineProps = {
 };
 
 const propsWithVolumeConfig: ImagePipelineProps = {
-  componentDocuments: ['test/test_component_example.yml'],
-  componentNames: ['TestComponent'],
-  componentVersions: ['1.0.0'],
+  components: [
+    {
+      document: 'test/test_component_example.yml',
+      name: 'TestComponent',
+      version: '1.0.0',
+    },
+  ],
   profileName: 'TestProfile',
   infraConfigName: 'TestInfrastructureConfig',
   imageRecipe: 'TestImageRecipe',
@@ -200,7 +217,7 @@ test.skip('Infrastructure Configuration DependsOn Instance Profile', () => {
 });
 
 test('Image Builder Component is created', () => {
-  template.resourceCountIs('AWS::ImageBuilder::Component', props.componentDocuments.length);
+  template.resourceCountIs('AWS::ImageBuilder::Component', props.components.length);
 });
 
 test('Image Recipe is created', () => {
@@ -220,4 +237,4 @@ test('Image Pipeline has Inspector vulnerability scans configured', () => {
       },
     },
   });
-});
+});