interface NotificationRuleOptions

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

Standard set of options for notifyOnXxx codestar notification handler on construct.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codestarnotifications as codestarnotifications } from 'aws-cdk-lib';
const notificationRuleOptions: codestarnotifications.NotificationRuleOptions = {
  createdBy: 'createdBy',
  detailType: codestarnotifications.DetailType.BASIC,
  enabled: false,
  notificationRuleName: 'notificationRuleName',
};

Properties

Name	Type	Description
createdBy?	`string`	The name or email alias of the person who created the notification rule.
detailType?	`DetailType`	The level of detail to include in the notifications for this resource.
enabled?	`boolean`	The status of the notification rule.
notificationRuleName?	`string`	The name for the notification rule.

createdBy?

Type: string (optional, default: No alias provided)

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

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

detailType?

Type: DetailType (optional, default: 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?

Type: boolean (optional, default: true)

The status of the notification rule.

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

notificationRuleName?

Type: string (optional, default: generated from the id)

The name for the notification rule.

Notification rule names must be unique in your AWS account.