Package software.amazon.awscdk.services.codestarnotifications


@Stability(Stable) @Deprecated package software.amazon.awscdk.services.codestarnotifications
Deprecated.

AWS CodeStarNotifications Construct Library

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.


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

NotificationRule

The NotificationRule construct defines an AWS CodeStarNotifications rule. The rule specifies the events you want notifications about and the targets (such as Amazon SNS topics or AWS Chatbot clients configured for Slack) where you want to receive them. Notification targets are objects that implement the INotificationRuleTarget interface and notification source is object that implement the INotificationRuleSource interface.

Notification Targets

This module includes classes that implement the INotificationRuleTarget interface for SNS and slack in AWS Chatbot.

The following targets are supported:

  • SNS: specify event and notify to SNS topic.
  • AWS Chatbot: specify event and notify to slack channel and only support SlackChannelConfiguration.

Examples

 import software.amazon.awscdk.services.codestarnotifications.*;
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.chatbot.*;
 
 
 PipelineProject project = new PipelineProject(this, "MyProject");
 
 Topic topic = new Topic(this, "MyTopic1");
 
 SlackChannelConfiguration slack = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 
 NotificationRule rule = NotificationRule.Builder.create(this, "NotificationRule")
         .source(project)
         .events(List.of("codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed"))
         .targets(List.of(topic))
         .build();
 rule.addTarget(slack);
 

Notification Source

This module includes classes that implement the INotificationRuleSource interface for AWS CodeBuild, AWS CodePipeline and will support AWS CodeCommit, AWS CodeDeploy in future.

The following sources are supported:

  • AWS CodeBuild: support codebuild project to trigger notification when event specified.
  • AWS CodePipeline: support codepipeline to trigger notification when event specified.

Events

For the complete list of supported event types for CodeBuild and CodePipeline, see:

Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html