Skip navigation links

Package software.amazon.awscdk.services.codestarnotifications

AWS CodeStarNotifications Construct Library

See: Description

Package software.amazon.awscdk.services.codestarnotifications Description

AWS CodeStarNotifications Construct Library

---

cfn-resources: Stable

cfn-resources: Stable


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:

Examples

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 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(stack, "MyProject");
 
 Topic topic = new Topic(stack, "MyTopic1");
 
 SlackChannelConfiguration slack = new SlackChannelConfiguration(stack, "MySlackChannel", new SlackChannelConfigurationProps()
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID"));
 
 NotificationRule rule = new NotificationRule(stack, "NotificationRule", new NotificationRuleProps()
         .source(project)
         .events(asList("codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed"))
         .targets(asList(topic)));
 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:

Events

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

Skip navigation links