See: Description
Interface | Description |
---|---|
CfnNotificationRule.TargetProperty |
Information about the AWS Chatbot topics or AWS Chatbot clients associated with a notification rule.
|
CfnNotificationRuleProps |
Properties for defining a `CfnNotificationRule`.
|
INotificationRule |
Represents a notification rule.
|
INotificationRule.Jsii$Default |
Internal default implementation for
INotificationRule . |
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 . |
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 . |
NotificationRuleOptions |
Standard set of options for `notifyOnXxx` codestar notification handler on construct.
|
NotificationRuleProps |
Properties for a new notification rule.
|
NotificationRuleSourceConfig |
Information about the Codebuild or CodePipeline associated with a notification source.
|
NotificationRuleTargetConfig |
Information about the SNS topic or AWS Chatbot client associated with a notification target.
|
Enum | Description |
---|---|
DetailType |
The level of detail to include in the notifications for this resource.
|
---
This module is part of the AWS Cloud Development Kit project.
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.
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
.
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);
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.
For the complete list of supported event types for CodeBuild and CodePipeline, see: