| 1 | import { EventPattern } from './event-pattern';
|
| 2 | import { IRuleTarget } from './target';
|
| 3 | /**
|
| 4 | * Standard set of options for `onXxx` event handlers on construct
|
| 5 | */
|
| 6 | export interface OnEventOptions {
|
| 7 | /**
|
| 8 | * The target to register for the event
|
| 9 | *
|
| 10 | * @default - No target is added to the rule. Use `addTarget()` to add a target.
|
| 11 | */
|
| 12 | readonly target?: IRuleTarget;
|
| 13 | /**
|
| 14 | * A description of the rule's purpose.
|
| 15 | *
|
| 16 | * @default - No description
|
| 17 | */
|
| 18 | readonly description?: string;
|
| 19 | /**
|
| 20 | * A name for the rule.
|
| 21 | *
|
| 22 | * @default AWS CloudFormation generates a unique physical ID.
|
| 23 | */
|
| 24 | readonly ruleName?: string;
|
| 25 | /**
|
| 26 | * Additional restrictions for the event to route to the specified target
|
| 27 | *
|
| 28 | * The method that generates the rule probably imposes some type of event
|
| 29 | * filtering. The filtering implied by what you pass here is added
|
| 30 | * on top of that filtering.
|
| 31 | *
|
| 32 | * @default - No additional filtering based on an event pattern.
|
| 33 | *
|
| 34 | * @see
|
| 35 | * https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
|
| 36 | */
|
| 37 | readonly eventPattern?: EventPattern;
|
| 38 | }
|