Table of Contents

Class CfnNotificationRule

Namespace
Amazon.CDK.AWS.CodeStarNotifications
Assembly
Amazon.CDK.AWS.CodeStarNotifications.dll

A CloudFormation AWS::CodeStarNotifications::NotificationRule.

public class CfnNotificationRule : CfnResource, IInspectable
Inheritance
CfnNotificationRule
Implements
IInspectable

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 cfnNotificationRule = new CfnNotificationRule(this, "MyCfnNotificationRule", 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

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as AWS Chatbot topics or AWS Chatbot clients configured for Slack) where you want to receive them.

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

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

ExampleMetadata: fixture=_generated

Constructors

CfnNotificationRule(Construct, string, ICfnNotificationRuleProps)

Create a new AWS::CodeStarNotifications::NotificationRule.

public CfnNotificationRule(Construct scope, string id, ICfnNotificationRuleProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnNotificationRuleProps
  • resource properties.

Properties

AttrArn 

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties 

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

CreatedBy

AWS::CodeStarNotifications::NotificationRule.CreatedBy.

public virtual string? CreatedBy { get; set; }

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.

public virtual string DetailType { get; set; }

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.

public virtual string? EventTypeId { get; set; }

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.

public virtual string[] EventTypeIds { get; set; }

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.

public virtual string Name { get; set; }

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.

public virtual string Resource { get; set; }

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.

public virtual string? Status { get; set; }

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.

public virtual TagManager Tags { get; }

Property Value

TagManager

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.

public virtual string? TargetAddress { get; set; }

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.

public virtual object Targets { get; set; }

Property Value

object

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>) 

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>