aws-cdk-lib.aws_events.EventCommonOptions

interface EventCommonOptions

LanguageType name
.NETAmazon.CDK.AWS.Events.EventCommonOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#EventCommonOptions
Javasoftware.amazon.awscdk.services.events.EventCommonOptions
Pythonaws_cdk.aws_events.EventCommonOptions
TypeScript (source)aws-cdk-lib » aws_events » EventCommonOptions

Common options for Events.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
declare const detail: any;
const eventCommonOptions: events.EventCommonOptions = {
  crossStackScope: construct,
  description: 'description',
  eventPattern: {
    account: ['account'],
    detail: {
      detailKey: detail,
    },
    detailType: ['detailType'],
    id: ['id'],
    region: ['region'],
    resources: ['resources'],
    source: ['source'],
    time: ['time'],
    version: ['version'],
  },
  ruleName: 'ruleName',
};

Properties

NameTypeDescription
crossStackScope?ConstructThe scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
description?stringA description of the rule's purpose.
eventPattern?EventPatternAdditional restrictions for the event to route to the specified target.
ruleName?stringA name for the rule.

crossStackScope?

Type: Construct (optional, default: none (the main scope will be used, even for cross-stack Events))

The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).

This helps dealing with cycles that often arise in these situations.


description?

Type: string (optional, default: No description)

A description of the rule's purpose.


eventPattern?

Type: EventPattern (optional, default: No additional filtering based on an event pattern.)

Additional restrictions for the event to route to the specified target.

The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html


ruleName?

Type: string (optional, default: AWS CloudFormation generates a unique physical ID.)

A name for the rule.