Class CfnNotificationRule
Creates a notification rule for a resource.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeStarNotifications
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNotificationRule : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnNotificationRule
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or AWS Chatbot clients configured for Slack) where you want to receive them.
CloudformationResource: AWS::CodeStarNotifications::NotificationRule
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 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"
});
Synopsis
Constructors
CfnNotificationRule(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnNotificationRule(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnNotificationRule(Construct, String, ICfnNotificationRuleProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the notification rule. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
EventTypeId | The event type associated with this notification rule. |
EventTypeIds | A list of event types associated with this notification rule. |
Name | The name for the notification rule. |
Resource | The Amazon Resource Name (ARN) of the resource to associate with the notification rule. |
Status | The status of the notification rule. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of tags to apply to this notification rule. |
TargetAddress | The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client. |
Targets | A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnNotificationRule(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnNotificationRule(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnNotificationRule(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnNotificationRule(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnNotificationRule(Construct, String, ICfnNotificationRuleProps)
public CfnNotificationRule(Construct scope, string id, ICfnNotificationRuleProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnNotificationRuleProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the notification rule.
public virtual string AttrArn { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CreatedBy
The name or email alias of the person who created the notification rule.
public virtual string CreatedBy { get; set; }
Property Value
System.String
DetailType
The level of detail to include in the notifications for this resource.
public virtual string DetailType { get; set; }
Property Value
System.String
EventTypeId
The event type associated with this notification rule.
public virtual string EventTypeId { get; set; }
Property Value
System.String
EventTypeIds
A list of event types associated with this notification rule.
public virtual string[] EventTypeIds { get; set; }
Property Value
System.String[]
Name
The name for the notification rule.
public virtual string Name { get; set; }
Property Value
System.String
Resource
The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
public virtual string Resource { get; set; }
Property Value
System.String
Status
The status of the notification rule.
public virtual string Status { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of tags to apply to this notification rule.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
TargetAddress
The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
public virtual string TargetAddress { get; set; }
Property Value
System.String
Targets
A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
public virtual object Targets { get; set; }
Property Value
System.Object
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>