@aws-cdk/aws-codestarnotifications

What is @aws-cdk/aws-codestarnotifications?

@aws-cdk/aws-codestarnotifications is an AWS CDK library that allows you to create and manage AWS CodeStar Notifications. This package helps you set up notifications for various AWS Code services like CodeBuild, CodePipeline, and CodeCommit, enabling you to receive alerts on different events such as build failures, pipeline state changes, and repository updates.

What are @aws-cdk/aws-codestarnotifications's main functionalities?

Create Notification Rule for CodeBuild

{"TypeScript":"import * as cdk from '@aws-cdk/core';\nimport * as codestarnotifications from '@aws-cdk/aws-codestarnotifications';\nimport * as codebuild from '@aws-cdk/aws-codebuild';\n\nconst app = new cdk.App();\nconst stack = new cdk.Stack(app, 'MyStack');\n\nconst project = new codebuild.PipelineProject(stack, 'MyProject');\n\nnew codestarnotifications.NotificationRule(stack, 'MyNotificationRule', {\n  source: project,\n  events: [\n    'codebuild-project-build-state-succeeded',\n    'codebuild-project-build-state-failed'\n  ],\n  targets: [\n    new codestarnotifications.SlackChannelConfiguration(stack, 'MySlackChannel', {\n      slackChannelConfigurationName: 'my-slack-channel',\n      slackWorkspaceId: 'T00000000',\n      slackChannelId: 'C00000000'\n    })\n  ]\n});","description":"This code sample demonstrates how to create a notification rule for an AWS CodeBuild project. The rule triggers notifications for build state changes (succeeded or failed) and sends them to a specified Slack channel."}

Create Notification Rule for CodePipeline

{"TypeScript":"import * as cdk from '@aws-cdk/core';\nimport * as codestarnotifications from '@aws-cdk/aws-codestarnotifications';\nimport * as codepipeline from '@aws-cdk/aws-codepipeline';\n\nconst app = new cdk.App();\nconst stack = new cdk.Stack(app, 'MyStack');\n\nconst pipeline = new codepipeline.Pipeline(stack, 'MyPipeline');\n\nnew codestarnotifications.NotificationRule(stack, 'MyNotificationRule', {\n  source: pipeline,\n  events: [\n    'codepipeline-pipeline-pipeline-execution-failed',\n    'codepipeline-pipeline-pipeline-execution-succeeded'\n  ],\n  targets: [\n    new codestarnotifications.SlackChannelConfiguration(stack, 'MySlackChannel', {\n      slackChannelConfigurationName: 'my-slack-channel',\n      slackWorkspaceId: 'T00000000',\n      slackChannelId: 'C00000000'\n    })\n  ]\n});","description":"This code sample demonstrates how to create a notification rule for an AWS CodePipeline. The rule triggers notifications for pipeline execution state changes (succeeded or failed) and sends them to a specified Slack channel."}

Create Notification Rule for CodeCommit

{"TypeScript":"import * as cdk from '@aws-cdk/core';\nimport * as codestarnotifications from '@aws-cdk/aws-codestarnotifications';\nimport * as codecommit from '@aws-cdk/aws-codecommit';\n\nconst app = new cdk.App();\nconst stack = new cdk.Stack(app, 'MyStack');\n\nconst repository = new codecommit.Repository(stack, 'MyRepository', {\n  repositoryName: 'my-repo'\n});\n\nnew codestarnotifications.NotificationRule(stack, 'MyNotificationRule', {\n  source: repository,\n  events: [\n    'codecommit-repository-comments-on-commits',\n    'codecommit-repository-pull-request-created'\n  ],\n  targets: [\n    new codestarnotifications.SlackChannelConfiguration(stack, 'MySlackChannel', {\n      slackChannelConfigurationName: 'my-slack-channel',\n      slackWorkspaceId: 'T00000000',\n      slackChannelId: 'C00000000'\n    })\n  ]\n});","description":"This code sample demonstrates how to create a notification rule for an AWS CodeCommit repository. The rule triggers notifications for events such as comments on commits and pull request creation, and sends them to a specified Slack channel."}

Other packages similar to @aws-cdk/aws-codestarnotifications

@aws-cdk/aws-sns

@aws-cdk/aws-sns is a CDK library for creating and managing Amazon Simple Notification Service (SNS) topics. While it provides a broader range of notification capabilities beyond CodeStar services, it requires more manual setup for integrating with CodeBuild, CodePipeline, and CodeCommit.

@aws-cdk/aws-chatbot

@aws-cdk/aws-chatbot is a CDK library for setting up AWS Chatbot, which integrates with Slack and Amazon Chime to provide notifications. It can be used in conjunction with SNS to receive notifications from various AWS services, including CodeStar services, but requires additional configuration.

@aws-cdk/aws-events

@aws-cdk/aws-events is a CDK library for creating and managing Amazon EventBridge (formerly CloudWatch Events) rules. It allows you to route events from various AWS services to different targets, including SNS and Lambda. It provides more flexibility but requires more setup compared to @aws-cdk/aws-codestarnotifications.

README

AWS::CodeStarNotifications Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

---

This module is part of the AWS Cloud Development Kit project.

import codestarnotifications = require('@aws-cdk/aws-codestarnotifications');

Changelog

1.34.1 (2020-04-22)

Bug Fixes

• cli: Javascript init-templates cannot be synthesized (ce4b8dd), closes #7356