aws-cdk.aws-codestarnotifications

What it is and what it does

This package provides AWS CDK v1 constructs for defining notification rules that route events from AWS CodeBuild and CodePipeline to notification targets like SNS topics and Slack channels configured in AWS Chatbot. It implements the INotificationRuleSource and INotificationRuleTarget interfaces, allowing you to declaratively specify which build or pipeline events trigger notifications and where those notifications are sent.

The package is part of the broader AWS CDK project and integrates with other CDK modules for compute and messaging services. However, AWS CDK v1 reached end-of-support on 2023-06-01 and is no longer maintained; the AWS team recommends migrating to AWS CDK v2 for new projects and for ongoing support and security updates.

Use it for:

• Route CodeBuild project build success/failure events to an SNS topic for email or SMS alerts.
• Send CodePipeline stage transition events to a Slack channel via AWS Chatbot for team visibility.
• Combine multiple notification sources and targets in a single CDK stack to centralize event routing.
• Trigger custom Lambda functions via SNS subscriptions when specific build or pipeline events occur.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Defines AWS CodeStarNotifications rules in Python using AWS CDK v1 constructs, routing build and pipeline events to SNS topics and Slack channels via AWS Chatbot.

No, unless you are maintaining an existing AWS CDK v1 codebase. AWS CDK v1 reached end-of-support on 2023-06-01 and is no longer updated. For new projects, use AWS CDK v2 and its equivalent notification constructs instead. If you are already on v1, this package works, but plan a migration to v2.

Install

aws-cdk-aws-codestarnotifications on PyPI

pip install aws-cdk-aws-codestarnotifications

uv add aws-cdk-aws-codestarnotifications

poetry add aws-cdk-aws-codestarnotifications

Installing aws-cdk.aws-codestarnotifications

Before you install

Low install friction with standard CDK dependencies. However, this is AWS CDK v1, which reached end-of-support on 2023-06-01 and is no longer being updated—new projects should use AWS CDK v2 instead.

License in practice

Licensed under Apache-2.0 (permissive), allowing commercial and private use with minimal restrictions.

Quickstart

pip install aws-cdk.aws-codestarnotifications

import aws_cdk.aws_codestarnotifications as notifications
import aws_cdk.aws_sns as sns

topic = sns.Topic(self, "MyTopic")
rule = notifications.NotificationRule(self, "Rule",
    source=project,
    events=["codebuild-project-build-state-succeeded"],
    targets=[topic]
)

Requires AWS CDK v1 runtime environment; users should migrate to AWS CDK v2 for ongoing support.

Verify before relying

• Whether this package can be used alongside AWS CDK v2 in the same project without conflicts.
• Current community adoption and whether migration tooling from v1 to v2 is mature.

Package facts

Evidence: aws_cdk.aws_codestarnotifications-1.204.0-py3-none-any.whl

Tags

More Build Tools packages