NotificationRuleOptions Struct
Standard set of options for notifyOnXxx codestar notification handler on construct.
Example
ts
// 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
createdByoptionalstringcreated_byoptionalstrcreatedByoptionalStringCreatedByoptionalstringCreatedByoptional*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.
detailTypeoptionalDetailTypedetail_typeoptionalDetailTypedetailTypeoptionalDetailTypeDetailTypeoptionalDetailTypeDetailTypeoptionalDetailType= 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.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#The status of the notification rule.
If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
notificationRuleNameoptionalstringnotification_rule_nameoptionalstrnotificationRuleNameoptionalStringNotificationRuleNameoptionalstringNotificationRuleNameoptional*string#The name for the notification rule.
Default: generated from the id
Notification rule names must be unique in your AWS account.