AWS CDKでCodePipelineとそのSlack通知を作成する

AWS CDK(Typescript)で CodePipeline とその Slack 通知連携を作成する方法と、その際に遭遇したエラーをまとめます。

バージョン

aws-cdk: 2.69.0

コード

API Referenceのサンプルを参考に、以下のようにコードを書きます。

lib/pipeline-stack.ts

import * as cdk from "aws-cdk-lib";
import { Construct } from "constructs";
import * as codepipeline from "aws-cdk-lib/aws-codepipeline";
import * as notifications from "aws-cdk-lib/aws-codestarnotifications";
import * as chatbot from "aws-cdk-lib/aws-chatbot";

export class PipelineStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const pipeline = new codepipeline.Pipeline(this, "MyPipeline");
    const slack = new chatbot.SlackChannelConfiguration(this, "MySlack", {
      slackChannelConfigurationName: "my-slack-configration",
      slackWorkspaceId: "XXXXXXXX",
      slackChannelId: "XXXXXXXXX",
    });
    new notifications.NotificationRule(
      this,
      "MyRule",
      {
        source: pipeline,
        events: [
          "codepipeline-pipeline-pipeline-execution-failed",
          "codepipeline-pipeline-pipeline-execution-canceled",
          "codepipeline-pipeline-pipeline-execution-started",
          "codepipeline-pipeline-pipeline-execution-succeeded",
          "codepipeline-pipeline-stage-execution-started",
          "codepipeline-pipeline-stage-execution-succeeded",
          "codepipeline-pipeline-stage-execution-failed",
          "codepipeline-pipeline-stage-execution-canceled",
        ],
        targets: [slack],
      }
    );
  }
}

slackWorkspaceIdとslackChannelIdは、ブラウザ版 Slack の URL から取得できます。
ブラウザ版 Slack で連携したいチャンネルを開き、以下を確認します。

https://app.slack.com/client/<slackWorkspaceId>/<slackChannelId>

slackChannelIdはアプリ版 Slack でも確認できます。
連携したいチャンネルでチャンネルの URL をコピーし、以下を確認します。

https://<workspaceName>.slack.com/archives/<slackChannelId>

slackWorkspaceIdは後述する方法でも確認できます。

エラーその 1

cdk deployを実行すると、以下のエラーが発生しました。

Invalid request provided: AWS Chatbot can't create the configuration because Slack workspace <slackWorkspaceId> is not authorized with AWS account <AWS ACCOUNT>. See  https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html#slack-client-setup

案内されたリンクによると、Slack と AWS の連携はあらかじめマネジメントコンソールから設定する必要があるようでした。
設定すると、マネジメントコンソール画面でもslackWorkspaceIdが確認できます。

エラーその 2

あらためてcdk deployを実行すると、以下のエラーが発生しました。

Invalid request provided: AWS::CodeStarNotifications::NotificationRule

これについては同じような事象に遭遇した方がいらっしゃいました。

特に何も変更はせず、cdk deployを再実行したところ、今度は成功しました。

まとめ

以上、AWS CDK(Typescript)で CodePipeline とその Slack 通知連携を作成する方法と、その際に遭遇したエラーをまとめました。