Addressed review comments

Author: Tarun Belani

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

@@ -47,7 +47,7 @@ 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.
 
-#### Basic Usage
+#### Basic Component Usage
 
 Create a component with the required properties: platform and component data.
 
@@ -301,7 +301,7 @@ const infrastructureConfiguration = new imagebuilder.InfrastructureConfiguration
 
 Workflows define the sequence of steps that Image Builder performs during image creation. There are three workflow types: BUILD (image building), TEST (testing images), and DISTRIBUTION (distributing container images).
 
-#### Basic Usage
+#### Basic Workflow Usage
 
 Create a workflow with the required properties: workflow type and workflow data.
 

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

@@ -2,7 +2,6 @@
   "exclude": [
     "props-no-arn-refs:@aws-cdk/aws-imagebuilder-alpha.InfrastructureConfigurationProps.ec2InstanceHostResourceGroupArn",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowAction",
-    "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowConfiguration",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowOnFailure",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowParameterType",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowSchemaVersion"

packages/@aws-cdk/aws-imagebuilder-alpha/lib/component.ts

@@ -6,7 +6,7 @@ import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as s3assets from 'aws-cdk-lib/aws-s3-assets';
 import { propertyInjectable } from 'aws-cdk-lib/core/lib/prop-injectable';
 import { Construct } from 'constructs';
-import * as yaml from 'yaml';
+import { ImageBuilderData } from './imagebuilder-data';
 import { OSVersion, Platform } from './os-version';
 
 const COMPONENT_SYMBOL = Symbol.for('@aws-cdk/aws-imagebuilder-alpha.Component');
@@ -640,7 +640,7 @@ export enum ComponentSchemaVersion {
 /**
  * Helper class for referencing and uploading component data
  */
-export abstract class ComponentData {
+export abstract class ComponentData extends ImageBuilderData {
   /**
    * Uploads component data from a local file to S3 to use as the component data
    *
@@ -655,7 +655,7 @@ export abstract class ComponentData {
     path: string,
     options: s3assets.AssetOptions = {},
   ): S3ComponentData {
-    const asset = new s3assets.Asset(scope, id, { ...options, path });
+    const asset = this.createAsset(scope, id, path, options);
     return new S3ComponentDataFromAsset(asset);
   }
 
@@ -675,7 +675,7 @@ export abstract class ComponentData {
    * @param data An inline JSON object representing the component data
    */
   public static fromJsonObject(data: { [key: string]: any }): ComponentData {
-    const inlineData = yaml.stringify(data, { indent: 2 });
+    const inlineData = this.createInlineYaml(data);
     return new InlineComponentData(inlineData);
   }
 
@@ -721,20 +721,6 @@ export abstract class ComponentData {
   public static fromInline(data: string): ComponentData {
     return new InlineComponentData(data);
   }
-
-  /**
-   * Indicates that the provided component data is an S3 reference
-   */
-  abstract readonly isS3Reference: boolean;
-
-  /**
-   * The resulting inline string or S3 URL which references the component data
-   */
-  public readonly value: string;
-
-  protected constructor(value: string) {
-    this.value = value;
-  }
 }
 
 /**
@@ -756,7 +742,7 @@ export abstract class S3ComponentData extends ComponentData {
   /**
    * Grant put permissions to the given grantee for the component data in S3
    *
-   * @param grantee The principal
+   * @param grantee - The principal
    */
   public grantPut(grantee: iam.IGrantable): iam.Grant {
     return this.bucket.grantPut(grantee, this.key);
@@ -765,7 +751,7 @@ export abstract class S3ComponentData extends ComponentData {
   /**
    * Grant read permissions to the given grantee for the component data in S3
    *
-   * @param grantee The principal
+   * @param grantee - The principal
    */
   public grantRead(grantee: iam.IGrantable): iam.Grant {
     return this.bucket.grantRead(grantee, this.key);

packages/@aws-cdk/aws-imagebuilder-alpha/lib/imagebuilder-data.ts

@@ -0,0 +1,43 @@
+import * as s3assets from 'aws-cdk-lib/aws-s3-assets';
+import { Construct } from 'constructs';
+import * as yaml from 'yaml';
+
+/**
+ * Helper class for referencing and uploading ImageBuilder data (components, workflows, etc.)
+ *
+ * @internal
+ */
+export abstract class ImageBuilderData {
+  /**
+   * Protected method to create an S3 asset for use by derived classes
+   */
+  protected static createAsset(
+    scope: Construct,
+    id: string,
+    path: string,
+    options: s3assets.AssetOptions = {},
+  ): s3assets.Asset {
+    return new s3assets.Asset(scope, id, { ...options, path });
+  }
+
+  /**
+   * Protected method to create inline YAML data for use by derived classes
+   */
+  protected static createInlineYaml(data: { [key: string]: any }): string {
+    return yaml.stringify(data, { indent: 2 });
+  }
+
+  /**
+   * Indicates that the provided data is an S3 reference
+   */
+  abstract readonly isS3Reference: boolean;
+
+  /**
+   * The resulting inline string or S3 URL which references the data
+   */
+  public readonly value: string;
+
+  protected constructor(value: string) {
+    this.value = value;
+  }
+}

packages/@aws-cdk/aws-imagebuilder-alpha/lib/workflow.ts

@@ -5,7 +5,7 @@ import * as kms from 'aws-cdk-lib/aws-kms';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as s3assets from 'aws-cdk-lib/aws-s3-assets';
 import { Construct } from 'constructs';
-import * as yaml from 'yaml';
+import { ImageBuilderData } from './imagebuilder-data';
 
 const WORKFLOW_SYMBOL = Symbol.for('@aws-cdk/aws-imagebuilder-alpha.Workflow');
 
@@ -145,7 +145,7 @@ export interface WorkflowAttributes {
 
   /**
    * The version of the workflow
-   * - x.x.x
+   *
    * @default x.x.x
    */
   readonly workflowVersion?: string;
@@ -308,7 +308,7 @@ export enum WorkflowType {
 /**
  * Helper class for referencing and uploading workflow data
  */
-export abstract class WorkflowData {
+export abstract class WorkflowData extends ImageBuilderData {
   /**
    * Uploads workflow data from a local file to S3 to use as the workflow data
    *
@@ -322,8 +322,8 @@ export abstract class WorkflowData {
     id: string,
     path: string,
     options: s3assets.AssetOptions = {},
-  ): WorkflowData {
-    const asset = new s3assets.Asset(scope, id, { ...options, path });
+  ): S3WorkflowData {
+    const asset = this.createAsset(scope, id, path, options);
     return new S3WorkflowDataFromAsset(asset);
   }
 
@@ -343,7 +343,7 @@ export abstract class WorkflowData {
    * @param data An inline JSON object representing the workflow data
    */
   public static fromJsonObject(data: { [key: string]: any }): WorkflowData {
-    const inlineData = yaml.stringify(data, { indent: 2 });
+    const inlineData = this.createInlineYaml(data);
     return new InlineWorkflowData(inlineData);
   }
 
@@ -355,20 +355,6 @@ export abstract class WorkflowData {
   public static fromInline(data: string): WorkflowData {
     return new InlineWorkflowData(data);
   }
-
-  /**
-   * Indicates that the provided workflow data is an S3 reference
-   */
-  abstract readonly isS3Reference: boolean;
-
-  /**
-   * The resulting inline string or S3 URL which references the workflow data
-   */
-  public readonly value: string;
-
-  protected constructor(value: string) {
-    this.value = value;
-  }
 }
 
 /**
@@ -390,7 +376,7 @@ export abstract class S3WorkflowData extends WorkflowData {
   /**
    * Grant put permissions to the given grantee for the workflow data in S3
    *
-   * @param grantee - The principal
+   * @param grantee The principal
    */
   public grantPut(grantee: iam.IGrantable): iam.Grant {
     return this.bucket.grantPut(grantee, this.key);
@@ -399,7 +385,7 @@ export abstract class S3WorkflowData extends WorkflowData {
   /**
    * Grant read permissions to the given grantee for the workflow data in S3
    *
-   * @param grantee - The principal
+   * @param grantee The principal
    */
   public grantRead(grantee: iam.IGrantable): iam.Grant {
     return this.bucket.grantRead(grantee, this.key);