# NotificationRule A new notification rule. Extends: Construct › Resource › NotificationRule Implements: IResource, INotificationRule, IEnvironmentAware, INotificationRuleRef, IConstruct, IDependable - CloudFormation: [`AWS::CodeStarNotifications::NotificationRule`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-codestarnotifications-notificationrule.html) - L1 type: [`CfnNotificationRule`](/cdk/api/v2/docs/aws-cdk-lib.aws_codestarnotifications.CfnNotificationRule.html) - Source: [`aws-codestarnotifications/lib/notification-rule.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-codestarnotifications/lib/notification-rule.ts#L116) - Type last changed: v2.234.0 · 8 Jan 2026 ## Example ```ts 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); ``` ## Initializer ```ts new NotificationRule(scope: Construct, id: string, props: NotificationRuleProps) ``` ## Construct Props - `createdBy`: 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`: [DetailType](/cdk/api/v2/docs/aws-cdk-lib.aws_codestarnotifications.DetailType.html) = DetailType.FULL — The level of detail to include in the notifications for this resource. 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`: boolean = true — The status of the notification rule. If the enabled is set to DISABLED, notifications aren't sent for the notification rule. - `events`: string[] (required) — 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`: string — The name for the notification rule. **Default:** generated from the `id` Notification rule names must be unique in your AWS account. - `source`: [INotificationRuleSource](/cdk/api/v2/docs/aws-cdk-lib.aws_codestarnotifications.INotificationRuleSource.html) (required) — 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`: [INotificationRuleTarget](/cdk/api/v2/docs/aws-cdk-lib.aws_codestarnotifications.INotificationRuleTarget.html)[] — The targets to register for the notification destination. **Default:** No targets are added to the rule. Use `addTarget()` to add a target. ## Properties - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be different than the stack they were imported into. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `notificationRuleArn`: string (required) — The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde). - `notificationRuleRef`: [NotificationRuleReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_codestarnotifications.NotificationRuleReference.html) (required) — A reference to a NotificationRule resource. - `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined. ## Methods - `addTarget(target: INotificationRuleTarget): boolean` — Adds target to notification rule. **Parameters** - `target` — The SNS topic or AWS Chatbot Slack target. - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). - `fromNotificationRuleArn(scope: Construct, id: string, notificationRuleArn: string): INotificationRule` (static) — Import an existing notification rule provided an ARN. **Parameters** - `scope` — The parent creating construct. - `id` — The construct's name. - `notificationRuleArn` — Notification rule ARN (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde). - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise. - `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource. - `toString(): string` — Returns a string representation of this construct. - `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs.