Interface INotificationRuleOptions

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

Namespace: Amazon.CDK.AWS.CodeStarNotifications

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface INotificationRuleOptions

Syntax (vb)

Public Interface 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 {
                CreatedBy = "createdBy",
                DetailType = DetailType.BASIC,
                Enabled = false,
                NotificationRuleName = "notificationRuleName"
            };

Synopsis

Properties

CreatedBy	The name or email alias of the person who created the notification rule.
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.

Properties

CreatedBy

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

string? CreatedBy { get; }

Property Value

string

Remarks

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

Default: - No alias provided

DetailType

The level of detail to include in the notifications for this resource.

DetailType? DetailType { get; }

Property Value

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.

bool? Enabled { get; }

Property Value

bool?

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.

string? NotificationRuleName { get; }

Property Value

string

Remarks

Notification rule names must be unique in your AWS account.

Default: - generated from the id