Merge pull request #256 from lvthillo/main

feat: Add Name and Schedule props

Author: cmagee

API.md

@@ -38,7 +38,24 @@ export interface VolumeProps {
   readonly ebs: imagebuilder.CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty;
 }
 
+export interface ImagePipelineSchedule {
+  /**
+   * The cron expression for the schedule.
+   */
+  readonly scheduleExpression: string;
+
+  /**
+   * Optional pipeline execution start condition.
+   */
+  readonly pipelineExecutionStartCondition?: 'EXPRESSION_MATCH_ONLY' | 'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE';
+}
+
+
 export interface ImagePipelineProps {
+  /**
+   * Name of the Image Pipeline
+   */
+  readonly name?: string;
   /**
    * List of component props
    */
@@ -129,6 +146,10 @@ export interface ImagePipelineProps {
    * The tags attached to the resource created by Image Builder
    */
   readonly resourceTags?: {[key: string]: string};
+  /**
+   * Schedule configuration for the image pipeline.
+   */
+  readonly schedule?: ImagePipelineSchedule;
 }
 
 export class ImagePipeline extends Construct {
@@ -254,10 +275,21 @@ export class ImagePipeline extends Construct {
     let imagePipelineProps: imagebuilder.CfnImagePipelineProps;
     imagePipelineProps = {
       infrastructureConfigurationArn: infrastructureConfig.attrArn,
-      name: `${uid}ImagePipeline`,
+      name: props.name ? props.name : `${uid}ImagePipeline`,
       description: 'A sample image pipeline',
       imageRecipeArn: imageRecipe.attrArn,
     };
+
+    if (props.schedule) {
+      imagePipelineProps = {
+        ...imagePipelineProps,
+        schedule: {
+          scheduleExpression: props.schedule.scheduleExpression,
+          pipelineExecutionStartCondition: props.schedule.pipelineExecutionStartCondition || 'EXPRESSION_MATCH_ONLY',
+        },
+      };
+    }
+
     if (props.enableVulnScans) {
       imagePipelineProps = {
         ...imagePipelineProps,

src/index.ts

@@ -25,6 +25,7 @@ const props: ImagePipelineProps = {
   amiIdSsmPath: '/ec2-image-builder/al2-x86',
   amiIdSsmAccountId: '11223344556',
   amiIdSsmRegion: 'us-east-1',
+  name: 'TestImagePipeline',
 };
 
 const propsWithNetworking: ImagePipelineProps = {
@@ -69,6 +70,21 @@ const propsWithVolumeConfig: ImagePipelineProps = {
   distributionRegions: ['us-east-1'],
 };
 
+const propsWithSchedule: ImagePipelineProps = {
+  ...props,
+  schedule: {
+    scheduleExpression: 'cron(0 0 * * ? *)',
+    pipelineExecutionStartCondition: 'EXPRESSION_MATCH_ONLY',
+  },
+};
+
+const propsWithDefaultSchedule: ImagePipelineProps = {
+  ...props,
+  schedule: {
+    scheduleExpression: 'cron(0 12 * * ? *)',
+  },
+};
+
 beforeAll(() => {
   process.env.CDK_DEFAULT_ACCOUNT = '123456789012';
   process.env.CDK_DEFAULT_REGION = 'us-east-1';
@@ -83,6 +99,12 @@ beforeAll(() => {
   template = Template.fromStack(testStack);
 });
 
+test('Image Pipeline is created with custom name', () => {
+  template.hasResourceProperties('AWS::ImageBuilder::ImagePipeline', {
+    Name: 'TestImagePipeline',
+  });
+});
+
 test('Infrastructure Configuration SNS topic is created', () => {
   template.resourceCountIs('AWS::SNS::Topic', 1);
 });
@@ -238,6 +260,43 @@ test('Image Pipeline has Inspector vulnerability scans configured', () => {
   });
 });
 
+test('Image Pipeline supports schedule configuration', () => {
+  const app1 = new cdk.App();
+  const testStack1 = new cdk.Stack(app1, 'testStackWithSchedule', {
+    env: {
+      account: process.env.CDK_DEFAULT_ACCOUNT,
+      region: process.env.CDK_DEFAULT_REGION,
+    },
+  });
+
+  new ImagePipeline(testStack1, 'ImagePipelineWithSchedule', propsWithSchedule);
+  const templateWithSchedule = Template.fromStack(testStack1);
+
+  templateWithSchedule.hasResourceProperties('AWS::ImageBuilder::ImagePipeline', {
+    Schedule: {
+      ScheduleExpression: 'cron(0 0 * * ? *)',
+      PipelineExecutionStartCondition: 'EXPRESSION_MATCH_ONLY',
+    },
+  });
+
+  // Test with default execution condition
+  const app2 = new cdk.App();
+  const testStack2 = new cdk.Stack(app2, 'testStackWithDefaultSchedule', {
+    env: {
+      account: process.env.CDK_DEFAULT_ACCOUNT,
+      region: process.env.CDK_DEFAULT_REGION,
+    },
+  });
+
+  new ImagePipeline(testStack2, 'ImagePipelineWithDefaultSchedule', propsWithDefaultSchedule);
+  const templateWithDefaultSchedule = Template.fromStack(testStack2);
+
+  templateWithDefaultSchedule.hasResourceProperties('AWS::ImageBuilder::ImagePipeline', {
+    Schedule: {
+      ScheduleExpression: 'cron(0 12 * * ? *)',
+    },
+  });
+});
 
 test('ImagePipeline exposes components as properties', () => {
   const app = new cdk.App();