interface INotificationRule

Language	Type name
.NET	Amazon.CDK.AWS.CodeStarNotifications.INotificationRule
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodestarnotifications#INotificationRule
Java	software.amazon.awscdk.services.codestarnotifications.INotificationRule
Python	aws_cdk.aws_codestarnotifications.INotificationRule
TypeScript (source)	aws-cdk-lib » aws_codestarnotifications » INotificationRule

Implemented by NotificationRule

Obtainable from Project.notifyOn(), Project.notifyOnBuildFailed(), Project.notifyOnBuildSucceeded(), Repository.notifiyOnPullRequestMerged(), Repository.notifyOn(), Repository.notifyOnApprovalRuleOverridden(), Repository.notifyOnApprovalStatusChanged(), Repository.notifyOnBranchOrTagCreated(), Repository.notifyOnBranchOrTagDeleted(), Repository.notifyOnPullRequestComment(), Repository.notifyOnPullRequestCreated(), Repository.notifyOnPullRequestMerged(), Pipeline.notifyOn(), Pipeline.notifyOnAnyActionStateChange(), Pipeline.notifyOnAnyManualApprovalStateChange(), Pipeline.notifyOnAnyStageStateChange(), Pipeline.notifyOnExecutionStateChange(), NotificationRule.fromNotificationRuleArn()

Represents a notification rule.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
notificationRuleArn	string	The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde).
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

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

Type: Node

The tree node.

---

notificationRuleArn

Type: string

The ARN of the notification rule (i.e. arn:aws:codestar-notifications:::notificationrule/01234abcde).

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addTarget(target)	Adds target to notification rule.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addTarget(target)

public addTarget(target: INotificationRuleTarget): boolean

Parameters

• target INotificationRuleTarget — The SNS topic or AWS Chatbot Slack target.

Returns

• boolean

Adds target to notification rule.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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