aws-cdk-lib.aws_codestarnotifications.CfnNotificationRuleProps

interface CfnNotificationRuleProps

LanguageType name
.NETAmazon.CDK.AWS.CodeStarNotifications.CfnNotificationRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodestarnotifications#CfnNotificationRuleProps
Javasoftware.amazon.awscdk.services.codestarnotifications.CfnNotificationRuleProps
Pythonaws_cdk.aws_codestarnotifications.CfnNotificationRuleProps
TypeScript aws-cdk-lib » aws_codestarnotifications » CfnNotificationRuleProps

Properties for defining a CfnNotificationRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codestarnotifications as codestarnotifications } from 'aws-cdk-lib';
const cfnNotificationRuleProps: codestarnotifications.CfnNotificationRuleProps = {
  detailType: 'detailType',
  eventTypeIds: ['eventTypeIds'],
  name: 'name',
  resource: 'resource',
  targets: [{
    targetAddress: 'targetAddress',
    targetType: 'targetType',
  }],

  // the properties below are optional
  createdBy: 'createdBy',
  eventTypeId: 'eventTypeId',
  status: 'status',
  tags: {
    tagsKey: 'tags',
  },
  targetAddress: 'targetAddress',
};

Properties

NameTypeDescription
detailTypestringThe level of detail to include in the notifications for this resource.
eventTypeIdsstring[]A list of event types associated with this notification rule.
namestringThe name for the notification rule.
resourcestringThe Amazon Resource Name (ARN) of the resource to associate with the notification rule.
targetsIResolvable | IResolvable | TargetProperty[]A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.
createdBy?stringAWS::CodeStarNotifications::NotificationRule.CreatedBy.
eventTypeId?stringAWS::CodeStarNotifications::NotificationRule.EventTypeId.
status?stringThe status of the notification rule.
tags?{ [string]: string }A list of tags to apply to this notification rule.
targetAddress?stringAWS::CodeStarNotifications::NotificationRule.TargetAddress.

detailType

Type: string

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

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.


eventTypeIds

Type: string[]

A list of event types associated with this notification rule.

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


name

Type: string

The name for the notification rule.

Notification rule names must be unique in your AWS account .


resource

Type: string

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

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


targets

Type: IResolvable | IResolvable | TargetProperty[]

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule.


createdBy?

Type: string (optional)

AWS::CodeStarNotifications::NotificationRule.CreatedBy.


eventTypeId?

Type: string (optional)

AWS::CodeStarNotifications::NotificationRule.EventTypeId.


status?

Type: string (optional)

The status of the notification rule.

The default value is ENABLED . If the status is set to DISABLED , notifications aren't sent for the notification rule.


tags?

Type: { [string]: string } (optional)

A list of tags to apply to this notification rule.

Key names cannot start with " aws ".


targetAddress?

Type: string (optional)

AWS::CodeStarNotifications::NotificationRule.TargetAddress.