NotificationRuleProps Struct
Properties for a new notification rule.
Example
import * as notifications from 'aws-cdk-lib/aws-codestarnotifications';
import * as codebuild from 'aws-cdk-lib/aws-codebuild';
import * as sns from 'aws-cdk-lib/aws-sns';
import * as chatbot from 'aws-cdk-lib/aws-chatbot';
const project = new codebuild.PipelineProject(this, 'MyProject');
const topic = new sns.Topic(this, 'MyTopic1');
const slack = new chatbot.SlackChannelConfiguration(this, 'MySlackChannel', {
slackChannelConfigurationName: 'YOUR_CHANNEL_NAME',
slackWorkspaceId: 'YOUR_SLACK_WORKSPACE_ID',
slackChannelId: 'YOUR_SLACK_CHANNEL_ID',
});
const rule = new notifications.NotificationRule(this, 'NotificationRule', {
source: project,
events: [
'codebuild-project-build-state-succeeded',
'codebuild-project-build-state-failed',
],
targets: [topic],
notificationRuleName: 'MyNotificationRuleName',
enabled: true, // The default is true
detailType: notifications.DetailType.FULL, // The default is FULL
createdBy: 'Jone Doe',
});
rule.addTarget(slack);
import aws_cdk.aws_codestarnotifications as notifications
import aws_cdk.aws_codebuild as codebuild
import aws_cdk.aws_sns as sns
import aws_cdk.aws_chatbot as chatbot
project = codebuild.PipelineProject(self, "MyProject")
topic = sns.Topic(self, "MyTopic1")
slack = chatbot.SlackChannelConfiguration(self, "MySlackChannel",
slack_channel_configuration_name="YOUR_CHANNEL_NAME",
slack_workspace_id="YOUR_SLACK_WORKSPACE_ID",
slack_channel_id="YOUR_SLACK_CHANNEL_ID"
)
rule = notifications.NotificationRule(self, "NotificationRule",
source=project,
events=["codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed"
],
targets=[topic],
notification_rule_name="MyNotificationRuleName",
enabled=True, # The default is true
detail_type=notifications.DetailType.FULL, # The default is FULL
created_by="Jone Doe"
)
rule.add_target(slack)
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);
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.CodeStarNotifications;
using Amazon.CDK.AWS.CodeBuild;
using Amazon.CDK.AWS.SNS;
using Amazon.CDK.AWS.Chatbot;
var project = new PipelineProject(this, "MyProject");
var topic = new Topic(this, "MyTopic1");
var slack = new SlackChannelConfiguration(this, "MySlackChannel", new SlackChannelConfigurationProps {
SlackChannelConfigurationName = "YOUR_CHANNEL_NAME",
SlackWorkspaceId = "YOUR_SLACK_WORKSPACE_ID",
SlackChannelId = "YOUR_SLACK_CHANNEL_ID"
});
var rule = new NotificationRule(this, "NotificationRule", new NotificationRuleProps {
Source = project,
Events = new [] { "codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed" },
Targets = new [] { topic },
NotificationRuleName = "MyNotificationRuleName",
Enabled = true, // The default is true
DetailType = DetailType.FULL, // The default is FULL
CreatedBy = "Jone Doe"
});
rule.AddTarget(slack);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import codebuild "github.com/aws/aws-cdk-go/awscdk"
import sns "github.com/aws/aws-cdk-go/awscdk"
import chatbot "github.com/aws/aws-cdk-go/awscdk"
project := codebuild.NewPipelineProject(this, jsii.String("MyProject"))
topic := sns.NewTopic(this, jsii.String("MyTopic1"))
slack := chatbot.NewSlackChannelConfiguration(this, jsii.String("MySlackChannel"), &SlackChannelConfigurationProps{
SlackChannelConfigurationName: jsii.String("YOUR_CHANNEL_NAME"),
SlackWorkspaceId: jsii.String("YOUR_SLACK_WORKSPACE_ID"),
SlackChannelId: jsii.String("YOUR_SLACK_CHANNEL_ID"),
})
rule := notifications.NewNotificationRule(this, jsii.String("NotificationRule"), &NotificationRuleProps{
Source: project,
Events: []*string{
jsii.String("codebuild-project-build-state-succeeded"),
jsii.String("codebuild-project-build-state-failed"),
},
Targets: []INotificationRuleTarget{
topic,
},
NotificationRuleName: jsii.String("MyNotificationRuleName"),
Enabled: jsii.Boolean(true),
// The default is true
DetailType: notifications.DetailType_FULL,
// The default is FULL
CreatedBy: jsii.String("Jone Doe"),
})
rule.AddTarget(slack)
Properties
createdByoptionalstringcreated_byoptionalstrcreatedByoptionalStringCreatedByoptionalstringCreatedByoptional*string#Default: No alias provided
If not specified, it means that the creator's alias is not provided.
detailTypeoptionalDetailTypedetail_typeoptionalDetailTypedetailTypeoptionalDetailTypeDetailTypeoptionalDetailTypeDetailTypeoptionalDetailType= DetailType.FULL#notes
BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
notificationRuleNameoptionalstringnotification_rule_nameoptionalstrnotificationRuleNameoptionalStringNotificationRuleNameoptionalstringNotificationRuleNameoptional*string#Default: generated from the id
Notification rule names must be unique in your AWS account.
sourceINotificationRuleSourcesourceINotificationRuleSourcesourceINotificationRuleSourceSourceINotificationRuleSourceSourceINotificationRuleSourcerequired#Currently, Supported sources include pipelines in AWS CodePipeline, build projects in AWS CodeBuild, and repositories in AWS CodeCommit in this L2 constructor.
targetsoptionalINotificationRuleTarget[]targetsoptionaltyping.List[INotificationRuleTarget]targetsoptionalList<INotificationRuleTarget>TargetsoptionalINotificationRuleTarget[]Targetsoptional*[]INotificationRuleTarget#Default: No targets are added to the rule. Use addTarget() to add a target.