Class CfnNotificationRule

Creates a notification rule for a resource.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnNotificationRule

Implements

IInspectable

INotificationRuleRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CodeStarNotifications

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnNotificationRule : CfnResource, IInspectable, INotificationRuleRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnNotificationRule Inherits CfnResource Implements IInspectable, INotificationRuleRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

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 AWS::CodeStarNotifications::NotificationRule.

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	Creates a notification rule for a resource.
CfnPropertyNames	Creates a notification rule for a resource.
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.
NotificationRuleRef	A reference to a NotificationRule resource.
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 topic or client.
Targets	A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

Methods

ArnForNotificationRule(INotificationRuleRef)	Creates a notification rule for a resource.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnNotificationRule(object)	Checks whether the given object is a CfnNotificationRule.
RenderProperties(IDictionary<string, object>)	Creates a notification rule for a resource.

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

Construct identifier for this resource (unique in its scope).

props ICfnNotificationRuleProps

Resource properties.

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the notification rule.

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

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

CfnProperties

Creates a notification rule for a resource.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a notification rule for a resource.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

CreatedBy

The name or email alias of the person who created the notification rule.

public virtual string? CreatedBy { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

DetailType

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

public virtual string DetailType { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

EventTypeId

The event type associated with this notification rule.

public virtual string? EventTypeId { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

EventTypeIds

A list of event types associated with this notification rule.

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

Property Value

string[]

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Name

The name for the notification rule.

public virtual string Name { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

NotificationRuleRef

A reference to a NotificationRule resource.

public virtual INotificationRuleReference NotificationRuleRef { get; }

Property Value

INotificationRuleReference

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

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

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Status

The status of the notification rule.

public virtual string? Status { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

TagsRaw

A list of tags to apply to this notification rule.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

TargetAddress

The Amazon Resource Name (ARN) of the Amazon topic or client.

public virtual string? TargetAddress { get; set; }

Property Value

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Targets

A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

public virtual object Targets { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnNotificationRule.ITargetProperty)[]

Methods

ArnForNotificationRule(INotificationRuleRef)

Creates a notification rule for a resource.

public static string ArnForNotificationRule(INotificationRuleRef resource)

Parameters

resource INotificationRuleRef

Returns

string

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

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"
             });

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.

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

IsCfnNotificationRule(object)

Checks whether the given object is a CfnNotificationRule.

public static bool IsCfnNotificationRule(object x)

Parameters

x object

Returns

bool

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a notification rule for a resource.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The rule specifies the events you want notifications about and the targets (such as Amazon Simple Notification Service topics or clients configured for Slack) where you want to receive them.

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

CloudformationResource: AWS::CodeStarNotifications::NotificationRule

ExampleMetadata: fixture=_generated

Implements

IInspectable

INotificationRuleRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable