Interface ICfnNotificationRuleProps

Properties for defining a CfnNotificationRule.

Namespace: Amazon.CDK.AWS.CodeStarNotifications

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnNotificationRuleProps

Syntax (vb)

Public Interface ICfnNotificationRuleProps

Remarks

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

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

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 client.
Targets	A list of Amazon Resource Names (ARNs) of Amazon SNS topics and clients to associate with the notification rule.

Properties

CreatedBy

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

virtual string CreatedBy { get; }

Property Value

System.String

Remarks

See: 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.

string DetailType { get; }

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.

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

EventTypeId

The event type associated with this notification rule.

virtual string EventTypeId { get; }

Property Value

System.String

Remarks

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

See: 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.

string[] EventTypeIds { get; }

Property Value

System.String[]

Remarks

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

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

Name

The name for the notification rule.

string Name { get; }

Property Value

System.String

Remarks

Notification rule names must be unique in your AWS account .

See: 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.

string Resource { get; }

Property Value

System.String

Remarks

Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .

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

Status

The status of the notification rule.

virtual string Status { get; }

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.

See: 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.

virtual IDictionary<string, string> Tags { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Key names cannot start with " aws ".

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

TargetAddress

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

virtual string TargetAddress { get; }

Property Value

System.String

Remarks

See: 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 SNS topics and clients to associate with the notification rule.

object Targets { get; }

Property Value

System.Object

Remarks

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