aws-cdk-lib.aws_codestarnotifications.NotificationRuleProps

NotificationRuleProps Struct

Properties for a new notification rule.

NotificationRuleProps

extends

• NotificationRuleOptions

used as props by

• NotificationRule

Source

aws-codestarnotifications/lib/notification-rule.ts

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);

Properties

createdBy?optionalstringcreated_by?optionalstrcreatedBy?optionalStringCreatedBy?optionalstringCreatedBy?optional*string#

The name or email alias of the person who created the notification rule.

Default: No alias provided

If not specified, it means that the creator's alias is not provided.

detailType?optionalDetailTypedetail_type?optionalDetailTypedetailType?optionalDetailTypeDetailType?optionalDetailTypeDetailType?optionalDetailType= DetailType.FULL#

The level of detail to include in the notifications for this resource.

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.

enabled?optionalbooleanenabled?optionalboolenabled?optionalBooleanEnabled?optionalboolEnabled?optional*bool= true#

The status of the notification rule.

If the enabled is set to DISABLED, notifications aren't sent for the notification rule.

eventsstring[]eventstyping.List[str]eventsList<String>Eventsstring[]Events*[]*stringrequired#

A list of event types associated with this notification rule.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

notificationRuleName?optionalstringnotification_rule_name?optionalstrnotificationRuleName?optionalStringNotificationRuleName?optionalstringNotificationRuleName?optional*string#

The name for the notification rule.

Default: generated from the id

Notification rule names must be unique in your AWS account.

sourceINotificationRuleSourcesourceINotificationRuleSourcesourceINotificationRuleSourceSourceINotificationRuleSourceSourceINotificationRuleSourcerequired#

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

Currently, Supported sources include pipelines in AWS CodePipeline, build projects in AWS CodeBuild, and repositories in AWS CodeCommit in this L2 constructor.

targets?optionalINotificationRuleTarget[]targets?optionaltyping.List[INotificationRuleTarget]targets?optionalList<INotificationRuleTarget>Targets?optionalINotificationRuleTarget[]Targets?optional*[]INotificationRuleTarget#

The targets to register for the notification destination.

Default: No targets are added to the rule. Use addTarget() to add a target.