README.md

AWS CodePipeline Execution State Change Notification Stack

This AWS CDK Construct Stack receives all state changes of CodePipeline and sends a message to the specified notification destination when the CodePipeline is tagged with a specified tag. Therefore, you can send messages simply by adding tags without needing to configure notifications for each Pipeline.

Install

TypeScript

install by npm

npm install @gammarers/aws-codepipeline-execution-state-change-notification-stack

install by yarn

yarn add @gammarers/aws-codepipeline-execution-state-change-notification-stack

install by pnpm

pnpm add @gammarers/aws-codepipeline-execution-state-change-notification-stack

install by bun

bun add @gammarers/aws-codepipeline-execution-state-change-notification-stack

Example

import { App } from 'aws-cdk-lib';
import { CodePipelineExecutionStateChangeNotificationStack } from '@gammarers/aws-codepipeline-execution-state-change-notification-stack';

const app = new App();

const stack = new CodePipelineExecutionStateChangeNotificationStack(app, 'CodePipelineExecutionStateChangeNotificationStack', {
  targetResource: { // required
    tagKey: 'PipelineExecutionStateChangeNotification', // required, Specify the tag key set in CodePipeline
    tagValues: ['YES'], // required, Specify the tag value set in CodePipeline
  },
  notifications: {
    emails: [ // optional (but not notification)
      'foo@example.com',
    ],
  },
});

License

This project is licensed under the Apache-2.0 License.