Class CfnNotificationRule
A CloudFormation AWS::CodeStarNotifications::NotificationRule
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeStarNotifications
Assembly: Amazon.CDK.AWS.CodeStarNotifications.dll
Syntax (csharp)
public class CfnNotificationRule : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnNotificationRule
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
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
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(Construct, String, ICfnNotificationRuleProps) | Create a new |
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 |
Properties
AttrArn | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CreatedBy |
|
DetailType | The level of detail to include in the notifications for this resource. |
EventTypeId |
|
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 |
|
Targets | A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service 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(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 System.String
- scoped id of the resource.
- props ICfnNotificationRuleProps
- resource properties.
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
Properties
AttrArn
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
AWS::CodeStarNotifications::NotificationRule.CreatedBy
.
public virtual string CreatedBy { get; set; }
Property Value
System.String
Remarks
DetailType
The level of detail to include in the notifications for this resource.
public virtual 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
AWS::CodeStarNotifications::NotificationRule.EventTypeId
.
public virtual string EventTypeId { get; set; }
Property Value
System.String
Remarks
EventTypeIds
A list of event types associated with this notification rule.
public virtual 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 virtual 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 virtual 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 virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
Key names cannot start with " aws
".
TargetAddress
AWS::CodeStarNotifications::NotificationRule.TargetAddress
.
public virtual string TargetAddress { get; set; }
Property Value
System.String
Remarks
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
System.Object
Remarks
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>