interface CfnEventRuleProps

Language	Type name
.NET	`Amazon.CDK.aws_notifications.CfnEventRuleProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsnotifications#CfnEventRuleProps`
Java	`software.amazon.awscdk.services.notifications.CfnEventRuleProps`
Python	`aws_cdk.aws_notifications.CfnEventRuleProps`
TypeScript	`aws-cdk-lib` » `aws_notifications` » `CfnEventRuleProps`

Properties for defining a CfnEventRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_notifications as notifications } from 'aws-cdk-lib';
const cfnEventRuleProps: notifications.CfnEventRuleProps = {
  eventType: 'eventType',
  notificationConfigurationArn: 'notificationConfigurationArn',
  regions: ['regions'],
  source: 'source',

  // the properties below are optional
  eventPattern: 'eventPattern',
};

Properties

Name	Type	Description
eventType	`string`	The event type this rule should match with the EventBridge events.
notificationConfigurationArn	`string`	The ARN for the `NotificationConfiguration` associated with this `EventRule` .
regions	`string[]`	A list of AWS Regions that send events to this `EventRule` .
source	`string`	The event source this rule should match with the EventBridge event sources.
eventPattern?	`string`	An additional event pattern used to further filter the events this `EventRule` receives.

eventType

Type: string

The event type this rule should match with the EventBridge events.

It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

notificationConfigurationArn

Type: string

The ARN for the NotificationConfiguration associated with this EventRule .

regions

Type: string[]

A list of AWS Regions that send events to this EventRule .

source

Type: string

The event source this rule should match with the EventBridge event sources.

It must match with atleast one of the valid EventBridge event sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch . For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide .

eventPattern?

Type: string (optional)

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.