Interface NotificationRuleOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
NotificationRuleProps, PipelineNotifyOnOptions, ProjectNotifyOnOptions, RepositoryNotifyOnOptions
All Known Implementing Classes:
NotificationRuleOptions.Jsii$Proxy, NotificationRuleProps.Jsii$Proxy, PipelineNotifyOnOptions.Jsii$Proxy, ProjectNotifyOnOptions.Jsii$Proxy, RepositoryNotifyOnOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-23T02:06:29.980Z") @Stability(Stable) public interface NotificationRuleOptions extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.codestarnotifications.*;
 NotificationRuleOptions notificationRuleOptions = NotificationRuleOptions.builder()
         .detailType(DetailType.BASIC)
         .enabled(false)
         .notificationRuleName("notificationRuleName")
         .build();
 
  • Method Details

    • getDetailType

      @Stability(Stable) @Nullable default DetailType getDetailType()
      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.

      Default: DetailType.FULL

    • getEnabled

      @Stability(Stable) @Nullable default Boolean getEnabled()
      The status of the notification rule.

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

      Default: true

    • getNotificationRuleName

      @Stability(Stable) @Nullable default String getNotificationRuleName()
      The name for the notification rule.

      Notification rule names must be unique in your AWS account.

      Default: - generated from the `id`

    • builder

      @Stability(Stable) static NotificationRuleOptions.Builder builder()
      Returns:
      a NotificationRuleOptions.Builder of NotificationRuleOptions