Class CfnNotificationRuleProps
Properties for defining a CfnNotificationRule
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeStarNotifications
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNotificationRuleProps : Object, ICfnNotificationRuleProps
Syntax (vb)
Public Class CfnNotificationRuleProps
Inherits Object
Implements ICfnNotificationRuleProps
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 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"
};
Synopsis
Constructors
CfnNotificationRuleProps() |
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. |
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 | 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. |
Constructors
CfnNotificationRuleProps()
public CfnNotificationRuleProps()
Properties
CreatedBy
The name or email alias of the person who created the notification rule.
public string CreatedBy { get; set; }
Property Value
System.String
Remarks
DetailType
The level of detail to include in the notifications for this resource.
public string DetailType { get; set; }
Property Value
System.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.
EventTypeId
The event type associated with this notification rule.
public string EventTypeId { get; set; }
Property Value
System.String
Remarks
For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
EventTypeIds
A list of event types associated with this notification rule.
public string[] EventTypeIds { get; set; }
Property Value
System.String[]
Remarks
For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .
Name
The name for the notification rule.
public string Name { get; set; }
Property Value
System.String
Remarks
Notification rule names must be unique in your AWS account .
Resource
The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
public string Resource { get; set; }
Property Value
System.String
Remarks
Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .
Status
The status of the notification rule.
public string Status { get; set; }
Property Value
System.String
Remarks
The default value is ENABLED
. If the status is set to DISABLED
, notifications aren't sent for the notification rule.
Tags
A list of tags to apply to this notification rule.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Key names cannot start with " aws
".
TargetAddress
The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
public string TargetAddress { get; set; }
Property Value
System.String
Remarks
Targets
A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
public object Targets { get; set; }
Property Value
System.Object