Class NotificationRuleOptions
Standard set of options for notifyOnXxx
codestar notification handler on construct.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeStarNotifications
Assembly: Amazon.CDK.AWS.CodeStarNotifications.dll
Syntax (csharp)
public class NotificationRuleOptions : Object, INotificationRuleOptions
Syntax (vb)
Public Class NotificationRuleOptions
Inherits Object
Implements INotificationRuleOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeStarNotifications;
var notificationRuleOptions = new NotificationRuleOptions {
DetailType = DetailType.BASIC,
Enabled = false,
NotificationRuleName = "notificationRuleName"
};
Synopsis
Constructors
NotificationRuleOptions() |
Properties
DetailType | The level of detail to include in the notifications for this resource. |
Enabled | The status of the notification rule. |
NotificationRuleName | The name for the notification rule. |
Constructors
NotificationRuleOptions()
public NotificationRuleOptions()
Properties
DetailType
The level of detail to include in the notifications for this resource.
public Nullable<DetailType> DetailType { get; set; }
Property Value
System.Nullable<DetailType>
Remarks
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
Enabled
The status of the notification rule.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
Default: true
NotificationRuleName
The name for the notification rule.
public string NotificationRuleName { get; set; }
Property Value
System.String
Remarks
Notification rule names must be unique in your AWS account.
Default: - generated from the id