Package software.amazon.awscdk.services.codestarnotifications

package software.amazon.awscdk.services.codestarnotifications

AWS CodeStarNotifications Construct Library

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))
         .notificationRuleName("MyNotificationRuleName")
         .enabled(true) // The default is true
         .detailType(DetailType.FULL) // The default is FULL
         .createdBy("Jone Doe")
         .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:

• Events for notification rules on build projects.
• Events for notification rules on pipelines.

Class	Description
CfnNotificationRule	Creates a notification rule for a resource.
CfnNotificationRule.Builder	A fluent builder for CfnNotificationRule.
CfnNotificationRule.TargetProperty	Information about the AWS Chatbot topics or AWS Chatbot clients associated with a notification rule.
CfnNotificationRule.TargetProperty.Builder	A builder for CfnNotificationRule.TargetProperty
CfnNotificationRule.TargetProperty.Jsii$Proxy	An implementation for CfnNotificationRule.TargetProperty
CfnNotificationRuleProps	Properties for defining a CfnNotificationRule.
CfnNotificationRuleProps.Builder	A builder for CfnNotificationRuleProps
CfnNotificationRuleProps.Jsii$Proxy	An implementation for CfnNotificationRuleProps
DetailType	The level of detail to include in the notifications for this resource.
INotificationRule	Represents a notification rule.
INotificationRule.Jsii$Default	Internal default implementation for INotificationRule.
INotificationRule.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
INotificationRuleSource	Represents a notification source The source that allows CodeBuild and CodePipeline to associate with this rule.
INotificationRuleSource.Jsii$Default	Internal default implementation for INotificationRuleSource.
INotificationRuleSource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
INotificationRuleTarget	Represents a notification target That allows AWS Chatbot and SNS topic to associate with this rule target.
INotificationRuleTarget.Jsii$Default	Internal default implementation for INotificationRuleTarget.
INotificationRuleTarget.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
NotificationRule	A new notification rule.
NotificationRule.Builder	A fluent builder for NotificationRule.
NotificationRuleOptions	Standard set of options for notifyOnXxx codestar notification handler on construct.
NotificationRuleOptions.Builder	A builder for NotificationRuleOptions
NotificationRuleOptions.Jsii$Proxy	An implementation for NotificationRuleOptions
NotificationRuleProps	Properties for a new notification rule.
NotificationRuleProps.Builder	A builder for NotificationRuleProps
NotificationRuleProps.Jsii$Proxy	An implementation for NotificationRuleProps
NotificationRuleSourceConfig	Information about the Codebuild or CodePipeline associated with a notification source.
NotificationRuleSourceConfig.Builder	A builder for NotificationRuleSourceConfig
NotificationRuleSourceConfig.Jsii$Proxy	An implementation for NotificationRuleSourceConfig
NotificationRuleTargetConfig	Information about the SNS topic or AWS Chatbot client associated with a notification target.
NotificationRuleTargetConfig.Builder	A builder for NotificationRuleTargetConfig
NotificationRuleTargetConfig.Jsii$Proxy	An implementation for NotificationRuleTargetConfig