ProjectNotifyOnOptions Struct
Additional options to pass to the notification rule.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import { aws_codestarnotifications as codestarnotifications } from 'aws-cdk-lib';
const projectNotifyOnOptions: codebuild.ProjectNotifyOnOptions = {
events: [codebuild.ProjectNotificationEvents.BUILD_FAILED],
// the properties below are optional
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.
eventsProjectNotificationEvents[]eventstyping.List[ProjectNotificationEvents]eventsList<ProjectNotificationEvents>EventsProjectNotificationEvents[]Events*[]ProjectNotificationEventsrequired#A list of event types associated with this notification rule for CodeBuild Project.
For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
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.