Remove image pipeline execution settings

Author: Tarun Belani

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

@@ -267,43 +267,6 @@ Pipelines can be started programmatically to trigger image builds on-demand, in
 is useful for integrating pipelines with CI/CD workflows, triggering builds based on custom conditions, or creating
 images in response to events.
 
-##### Basic Pipeline Start
-
-Start a pipeline execution without additional configuration:
-
-```ts
-const builtImage = examplePipeline.start({});
-```
-
-##### Tagged Pipeline Builds
-
-Apply custom tags to images created from pipeline executions:
-
-```ts
-const taggedImage = examplePipeline.start({
-  tags: {
-    BuildNumber: '456',
-    Environment: 'Production'
-  }
-});
-```
-
-##### Triggering on Pipeline Updates
-
-Configure the pipeline to automatically trigger a new build whenever the pipeline itself is updated:
-
-```ts
-const triggeredImage = examplePipeline.start({
-  onUpdate: true,
-  tags: {
-    AutoBuild: 'true'
-  }
-});
-```
-
-The `start()` method returns an `Image` construct representing the pipeline execution, which can be referenced for
-additional operations or outputs.
-
 #### Importing Image Pipelines
 
 Reference existing pipelines created outside CDK:
@@ -1573,7 +1536,9 @@ const distributeContainerWorkflow = imagebuilder.AwsManagedWorkflow.distributeCo
 
 ### Lifecycle Policy
 
-Lifecycle policies help you manage the retention and cleanup of Image Builder resources automatically. These policies define rules for deprecating or deleting old image versions, managing AMI snapshots, and controlling resource costs by removing unused images based on age, count, or other criteria.
+Lifecycle policies help you manage the retention and cleanup of Image Builder resources automatically. These policies
+define rules for deprecating or deleting old image versions, managing AMI snapshots, and controlling resource costs by
+removing unused images based on age, count, or other criteria.
 
 #### Lifecycle Policy Basic Usage
 

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

@@ -2,8 +2,6 @@
   "exclude": [
     "props-no-arn-refs:@aws-cdk/aws-imagebuilder-alpha.InfrastructureConfigurationProps.ec2InstanceHostResourceGroupArn",
     "props-physical-name:@aws-cdk/aws-imagebuilder-alpha.ImageProps",
-    "construct-ctor-props-optional:@aws-cdk/aws-imagebuilder-alpha.Image",
-    "ref-via-interface:@aws-cdk/aws-imagebuilder-alpha.ImagePipelineExecutionSettings.imagePipeline",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.ContainerType",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowAction",
     "no-unused-type:@aws-cdk/aws-imagebuilder-alpha.WorkflowOnFailure",

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

@@ -7,7 +7,6 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import { propertyInjectable } from 'aws-cdk-lib/core/lib/prop-injectable';
 import { Construct } from 'constructs';
 import { IDistributionConfiguration } from './distribution-configuration';
-import { Image } from './image';
 import { IInfrastructureConfiguration, InfrastructureConfiguration } from './infrastructure-configuration';
 import {
   buildImageScanningConfiguration,
@@ -313,25 +312,6 @@ export interface ImagePipelineSchedule {
   readonly startCondition?: ScheduleStartCondition;
 }
 
-/**
- * Properties for creating by starting the associated image pipeline.
- */
-export interface StartImagePipelineProps {
-  /**
-   * Indicates whether to trigger a new image build when an update is made to the image pipeline
-   *
-   * @default false
-   */
-  readonly onUpdate?: boolean;
-
-  /**
-   * The tags to apply to the image created from the pipeline
-   *
-   * @default None
-   */
-  readonly tags?: { [key: string]: string };
-}
-
 /**
  * The start condition for the pipeline, indicating the condition under which a pipeline should be triggered.
  */
@@ -729,18 +709,6 @@ export class ImagePipeline extends ImagePipelineBase {
     this.imagePipelineDeploymentId = imagePipeline.attrDeploymentId;
   }
 
-  /**
-   * Starts an image build from this image pipeline.
-   *
-   * @param props Properties for creating by starting the associated image pipeline
-   */
-  public start(props: StartImagePipelineProps): Image {
-    return new Image(this, 'Image', {
-      imagePipelineExecutionSettings: { imagePipeline: this, onUpdate: props.onUpdate },
-      tags: props.tags,
-    });
-  }
-
   /**
    * Grants the default permissions for building an image to the provided execution role.
    *

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

@@ -7,7 +7,6 @@ import { propertyInjectable } from 'aws-cdk-lib/core/lib/prop-injectable';
 import { Construct } from 'constructs';
 import { BaseContainerImage, BaseImage } from './base-image';
 import { IDistributionConfiguration } from './distribution-configuration';
-import { ImagePipeline } from './image-pipeline';
 import { IInfrastructureConfiguration, InfrastructureConfiguration } from './infrastructure-configuration';
 import { LATEST_VERSION } from './private/constants';
 import {
@@ -90,16 +89,7 @@ export interface ImageProps {
    * @default - none if the image is created from an image pipeline with `imagePipelineExecutionSettings`. Otherwise,
    * a recipe is required.
    */
-  readonly recipe?: IRecipeBase;
-
-  /**
-   * The image pipeline execution settings of the image, used to create an image by invoking the provided image
-   * pipeline. You may only specify the `tags` property in conjunction with `imagePipelineExecutionSettings`.
-   *
-   * @default - none if the image is created directly using a recipe. Otherwise, the image pipeline execution setting is
-   * required.
-   */
-  readonly imagePipelineExecutionSettings?: ImagePipelineExecutionSettings;
+  readonly recipe: IRecipeBase;
 
   /**
    * The infrastructure configuration used for building the image.
@@ -205,23 +195,6 @@ export interface ImageProps {
   readonly tags?: { [key: string]: string };
 }
 
-/**
- * The image pipeline execution settings of the image, used to create an image by invoking the provided image pipeline.
- */
-export interface ImagePipelineExecutionSettings {
-  /**
-   * The image pipeline to start an image build from
-   */
-  readonly imagePipeline: ImagePipeline;
-
-  /**
-   * Indicates whether to trigger a new image build when an update is made to the image pipeline
-   *
-   * @default false
-   */
-  readonly onUpdate?: boolean;
-}
-
 /**
  * Properties for an EC2 Image Builder image
  */
@@ -462,26 +435,21 @@ export class Image extends ImageBase {
 
     Object.defineProperty(this, IMAGE_SYMBOL, { value: true });
 
-    this.validateImageProps(props);
-
     this.props = props;
 
-    const hasImagePipelineExecutionSettings = props.imagePipelineExecutionSettings !== undefined;
-
-    this.infrastructureConfiguration = hasImagePipelineExecutionSettings
-      ? props.imagePipelineExecutionSettings.imagePipeline.infrastructureConfiguration
-      : (props.infrastructureConfiguration ?? new InfrastructureConfiguration(this, 'InfrastructureConfiguration'));
+    this.infrastructureConfiguration =
+      props.infrastructureConfiguration ?? new InfrastructureConfiguration(this, 'InfrastructureConfiguration');
 
-    this.executionRole = hasImagePipelineExecutionSettings
-      ? props.imagePipelineExecutionSettings.imagePipeline.executionRole
-      : getExecutionRole(this, (grantee: iam.IGrantable) => this.grantDefaultExecutionRolePermissions(grantee), {
+    this.executionRole = getExecutionRole(
+      this,
+      (grantee: iam.IGrantable) => this.grantDefaultExecutionRolePermissions(grantee),
+      {
         ...props,
         imageLogGroup: props.logGroup,
-      });
+      },
+    );
 
-    const [image, recipe] = hasImagePipelineExecutionSettings
-      ? this.createImageFromPipelineExecutionSettings(props)
-      : this.createImageFromRecipe(props);
+    const [image, recipe] = this.createImageFromRecipe(props);
 
     this.imageName = this.getResourceNameAttribute(image.attrName);
     this.imageArn = image.attrArn;
@@ -523,7 +491,7 @@ export class Image extends ImageBase {
    * @private
    */
   private createImageFromRecipe(props: ImageProps): [CfnImage, IRecipeBase] {
-    const recipe = props.recipe!;
+    const recipe = props.recipe;
     if (InfrastructureConfiguration.isInfrastructureConfiguration(this.infrastructureConfiguration)) {
       this.infrastructureConfiguration._bind({ isContainerBuild: recipe._isContainerRecipe() });
     }
@@ -559,27 +527,6 @@ export class Image extends ImageBase {
     return [image, recipe];
   }
 
-  /**
-   * Creates a CfnImage resource from the image pipeline execution settings provided. This allows creation of images
-   * by starting an image pipeline.
-   *
-   * @param props Props input for the construct
-   * @private
-   */
-  private createImageFromPipelineExecutionSettings(props: ImageProps): [CfnImage, IRecipeBase] {
-    const imagePipelineExecutionSettings = props.imagePipelineExecutionSettings!;
-
-    const image = new CfnImage(this, 'Resource', {
-      imagePipelineExecutionSettings: {
-        deploymentId: imagePipelineExecutionSettings.imagePipeline.imagePipelineDeploymentId,
-        onUpdate: imagePipelineExecutionSettings.onUpdate,
-      },
-      tags: props.tags,
-    });
-
-    return [image, imagePipelineExecutionSettings.imagePipeline._recipe];
-  }
-
   /**
    * Generates the loggingConfiguration property into the `LoggingConfiguration` type in the CloudFormation L1
    * definition.
@@ -606,21 +553,4 @@ export class Image extends ImageBase {
 
     return { executionRole: props.deletionExecutionRole.roleArn };
   }
-
-  /**
-   * Validates the top-level properties of the image construct. Ensures that the Image gets created from either a recipe
-   * or an image pipeline.
-   *
-   * @param props Props input for the construct
-   * @private
-   */
-  private validateImageProps(props: ImageProps): void {
-    if (props.recipe === undefined && props.imagePipelineExecutionSettings === undefined) {
-      throw new cdk.ValidationError('either recipe or imagePipelineExecutionSettings is required', this);
-    }
-
-    if (props.recipe !== undefined && props.imagePipelineExecutionSettings !== undefined) {
-      throw new cdk.ValidationError('only one of recipe and imagePipelineExecutionSettings can be provided', this);
-    }
-  }
 }

packages/@aws-cdk/aws-imagebuilder-alpha/lib/private/image-and-pipeline-props-helper.ts

@@ -37,11 +37,11 @@ export const buildImageScanningConfiguration = <
   scope: Construct,
   props: PropsT,
 ): OutputT | undefined => {
-  if (!props.recipe!._isContainerRecipe() && props.imageScanningEcrRepository !== undefined) {
+  if (!props.recipe._isContainerRecipe() && props.imageScanningEcrRepository !== undefined) {
     throw new cdk.ValidationError('imageScanningEcrRepository is only supported for container recipe builds', scope);
   }
 
-  if (!props.recipe!._isContainerRecipe() && props.imageScanningEcrTags !== undefined) {
+  if (!props.recipe._isContainerRecipe() && props.imageScanningEcrTags !== undefined) {
     throw new cdk.ValidationError('imageScanningEcrTags is only supported for container recipe builds', scope);
   }
 

packages/@aws-cdk/aws-imagebuilder-alpha/lib/private/policy-helper.ts

@@ -277,7 +277,7 @@ export const defaultExecutionRolePolicy = <PropsT extends ImagePipelineProps | I
   ];
 
   const hasProps = props !== undefined;
-  if (!hasProps || (props.recipe!._isImageRecipe() && props.distributionConfiguration !== undefined)) {
+  if (!hasProps || (props.recipe._isImageRecipe() && props.distributionConfiguration !== undefined)) {
     // Distribution-specific permissions if distribution settings are provided. All permissions here are for AMI builds
     // specifically.
     policies.push(
@@ -365,7 +365,7 @@ export const defaultExecutionRolePolicy = <PropsT extends ImagePipelineProps | I
     );
 
     // Add image scanning ECR permissions for container builds
-    if (!hasProps || props.recipe!._isContainerRecipe()) {
+    if (!hasProps || props.recipe._isContainerRecipe()) {
       policies.push(
         new iam.PolicyStatement({
           effect: iam.Effect.ALLOW,

packages/@aws-cdk/aws-imagebuilder-alpha/test/image-pipeline.test.ts

@@ -427,37 +427,6 @@ describe('ImagePipeline', () => {
     });
   });
 
-  test('creates an image when starting a pipeline', () => {
-    const imagePipeline = new ImagePipeline(stack, 'ImagePipeline', {
-      recipe: ImageRecipe.fromImageRecipeName(stack, 'ImageRecipe', 'imported-image-recipe'),
-    });
-    imagePipeline.start({ onUpdate: true, tags: { key1: 'value1', key2: 'value2' } });
-
-    const template = Template.fromStack(stack);
-
-    template.resourceCountIs('AWS::IAM::Role', 1);
-    template.resourceCountIs('AWS::IAM::InstanceProfile', 1);
-    template.resourceCountIs('AWS::ImageBuilder::InfrastructureConfiguration', 1);
-    template.resourceCountIs('AWS::ImageBuilder::ImagePipeline', 1);
-    template.resourceCountIs('AWS::ImageBuilder::Image', 1);
-    expect(Object.keys(template.toJSON().Resources)).toHaveLength(5);
-
-    template.templateMatches({
-      Resources: {
-        ImagePipelineImage364D5BF8: Match.objectEquals({
-          Type: 'AWS::ImageBuilder::Image',
-          Properties: {
-            ImagePipelineExecutionSettings: {
-              DeploymentId: { 'Fn::GetAtt': ['ImagePipeline7DDDE57F', 'DeploymentId'] },
-              OnUpdate: true,
-            },
-            Tags: { key1: 'value1', key2: 'value2' },
-          },
-        }),
-      },
-    });
-  });
-
   test('generates an execution role when workflows are provided', () => {
     const imagePipeline = new ImagePipeline(stack, 'ImagePipeline', {
       recipe: ImageRecipe.fromImageRecipeName(stack, 'ImageRecipe', 'imported-image-recipe'),