codepipeline & codestart notification: unable to associate the source for the code pipeline on a notification

[akhilpatlolla]

Describe the bug

We are trying to create Code Pipeline and associate notifications to the code pipeline. Code pipelines got created sucessfully but when trying to associate a notification to it there are multiple issue and also the notification-rule-source.d.ts interface is confusing as well.

described 4 options here with 4 different version of soruce

option 1 : source: pipeline.pipeline,
option 2 : source: pipeline.pipeline.bindAsNotificationRuleSource(this),
option 3 : source: notificationRuleSourceConfig,
option 4 : source: pipelineSource,

code-pipeline.ts

import * as cdk from "aws-cdk-lib";
import { Construct } from "constructs";
import {
  CodePipeline,
  CodePipelineSource,
  ManualApprovalStep,
  ShellStep,
} from "aws-cdk-lib/pipelines";
import { Options } from "../../types";
import { CodePipelineStage } from "./application-stack";
import { Stage } from "../app.config";
import { BuildSpec, LinuxBuildImage } from "aws-cdk-lib/aws-codebuild";
import * as notifications from "aws-cdk-lib/aws-codestarnotifications";
import * as sns from "aws-cdk-lib/aws-sns";


export class CodePipelineStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props: PipelineStackProps) {
    const pipeline = new CodePipeline(this, `${prefix}-codepipeline`, {
      pipelineName: `${prefix}-codepipeline`,
      crossAccountKeys: true,
      codeBuildDefaults: {
        buildEnvironment: {
          buildImage: LinuxBuildImage.STANDARD_7_0,
        },
      },
      selfMutation: false,
      synth: new ShellStep("Synth", {
        input: CodePipelineSource.connection(repoString, branch, {
          connectionArn,
        }),
        // installCommands: ["npm i"],
        commands: ["cd cdkv2", "npm ci", "npx cdk synth"],
        primaryOutputDirectory: "cdkv2/cdk.out",
      }),

      synthCodeBuildDefaults: {
        buildEnvironment: {
          buildImage: LinuxBuildImage.STANDARD_7_0,
        },
        partialBuildSpec: BuildSpec.fromObject({
          phases: {
            install: {
              "runtime-versions": {
                nodejs: "18",
              },
            },
          },
        }),
      },
    });


   // trying other options as well here 

  const notificationRuleSourceConfig: notifications.NotificationRuleSourceConfig = {
      sourceArn:  pipeline.pipeline.pipelineArn,
    };

    const pipelineSource: notifications.INotificationRuleSource = {
      bindAsNotificationRuleSource: (scope: Construct) => {
        return notificationRuleSourceConfig;
      },
    };


  
    // pipeline.buildPipeline();
    new notifications.NotificationRule(
      this,
      `${props.stage}-CodePipelineMonitoringRule`,
      {
        
        // source: pipeline.pipeline, 
        // option 1
        // error : lib/codepipeline/code-pipeline-monitoring.ts:59:9 - error TS2741: Property 'bindAsNotificationRuleSource' is missing in type 'typeof CodePipeline' but required in type 'INotificationRuleSource'.


        source: pipeline.pipeline.bindAsNotificationRuleSource(this),
        // option 2
        // error : Property 'bindAsNotificationRuleSource' is missing in type 'NotificationRuleSourceConfig' but required in type 'INotificationRuleSource'.ts(2741) notification-rule-source.d.ts(19, 5): 'bindAsNotificationRuleSource' is declared here. notification-rule.d.ts(60, 14): The expected type comes from property 'source' which is declared here on type 'NotificationRuleProps'


        // source: notificationRuleSourceConfig,
        // option 3
        // error : Property 'bindAsNotificationRuleSource' is missing in type 'NotificationRuleSourceConfig' but required in type 'INotificationRuleSource'.ts(2741) notification-rule-source.d.ts(19, 5): 'bindAsNotificationRuleSource' is declared here. notification-rule.d.ts(60, 14): The expected type comes from property 'source' which is declared here on type 'NotificationRuleProps'



        // source: pipelineSource,
        // option 4
        // error : lib/codepipeline/code-pipeline-monitoring.ts:59:9 - error TS2741: Property 'bindAsNotificationRuleSource' is missing in type 'typeof CodePipeline' but required in type 'INotificationRuleSource'.


        events: [
          "codebuild-project-build-state-failed",
          "codebuild-project-build-phase-failure",
          "codedeploy-application-deployment-failed",
          "codepipeline-pipeline-action-execution-failed",
          "codepipeline-pipeline-stage-execution-failed",
          "codepipeline-pipeline-pipeline-execution-failed",
        ],
        targets: [PDTopic],
      }
    );
  }
}

notification-rule-source-d.ts

import * as constructs from 'constructs';
/**
 * Information about the Codebuild or CodePipeline associated with a notification source.
 */
export interface NotificationRuleSourceConfig {
    /**
     * The Amazon Resource Name (ARN) of the notification source.
     */
    readonly sourceArn: string;
}
/**
 * Represents a notification source
 * The source that allows CodeBuild and CodePipeline to associate with this rule.
 */
export interface INotificationRuleSource {
    /**
     * Returns a source configuration for notification rule.
     */
    bindAsNotificationRuleSource(scope: constructs.Construct): NotificationRuleSourceConfig;
}

Expected Behavior

expected to associate pipeline seamlessly to the notification.

Current Behavior

it's throwing bunch of errors.

Reproduction Steps

create a code pipeline and try to attach a code star notification to it using the pipeline object once it's created.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

[email protected] cdk

Framework Version

No response

Node.js Version

18

OS

mac os

Language

Typescript

Language Version

typescript 8.15

Other information

No response

[akhilpatlolla]

Other alternative approches suggested was to use pipeline.buidlpipeline() and pipeline.pipeline as an input for source but that doesn't work either.

[indrora]

Is this related to #9710 ? @TheRealAmazonKendra does this look similar?

[peterwoodworth]

@indrora could you dive deep into this yourself?

[akhilpatlolla]

any update on the issue ? @peterwoodworth / @indrora

[mascalucianppb]

Are there news related to this issue?
Referencing existing pipelines using NotificationsRule CDK construct still doesn't seem to work.

@peterwoodworth @indrora