Interface ICfnNotificationRuleProps

Namespace

Amazon.CDK.AWS.CodeStarNotifications

Assembly

Amazon.CDK.AWS.CodeStarNotifications.dll

Properties for defining a CfnNotificationRule.

public interface ICfnNotificationRuleProps

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 cfnNotificationRuleProps = new CfnNotificationRuleProps {
                 DetailType = "detailType",
                 EventTypeIds = new [] { "eventTypeIds" },
                 Name = "name",
                 Resource = "resource",
                 Targets = new [] { new TargetProperty {
                     TargetAddress = "targetAddress",
                     TargetType = "targetType"
                 } },

                 // the properties below are optional
                 CreatedBy = "createdBy",
                 EventTypeId = "eventTypeId",
                 Status = "status",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TargetAddress = "targetAddress"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html

ExampleMetadata: fixture=_generated

Properties

CreatedBy

AWS::CodeStarNotifications::NotificationRule.CreatedBy.

string? CreatedBy { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-createdby

DetailType

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

string DetailType { get; }

Property Value

string

Remarks

BASIC will include only the contents of the event as it would appear in Amazon 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-detailtype

EventTypeId

AWS::CodeStarNotifications::NotificationRule.EventTypeId.

string? EventTypeId { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeid

EventTypeIds

A list of event types associated with this notification rule.

string[] EventTypeIds { get; }

Property Value

string[]

Remarks

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeids

Name

The name for the notification rule.

string Name { get; }

Property Value

string

Remarks

Notification rule names must be unique in your AWS account .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-name

Resource

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

string Resource { get; }

Property Value

string

Remarks

Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource

Status

The status of the notification rule.

string? Status { get; }

Property Value

string

Remarks

The default value is ENABLED . If the status is set to DISABLED , notifications aren't sent for the notification rule.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-status

Tags

A list of tags to apply to this notification rule.

IDictionary<string, string>? Tags { get; }

Property Value

IDictionary<string, string>

Remarks

Key names cannot start with " aws ".

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-tags

TargetAddress

AWS::CodeStarNotifications::NotificationRule.TargetAddress.

string? TargetAddress { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targetaddress

Targets

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.

object Targets { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets