Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(events): add a note about not using EventPattern with CfnRule #16715

Merged
merged 3 commits into from
Oct 4, 2021
Merged

docs(events): add a note about not using EventPattern with CfnRule #16715

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a460129
docs(events): add a note about not using `EventPattern` with `CfnRule`
rix0rrr Sep 29, 2021
0848528
Merge branch 'master' into huijbers/pattern-note
rix0rrr Oct 4, 2021
8c9dffc
Merge branch 'master' into huijbers/pattern-note
mergify[bot] Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/@aws-cdk/aws-events/lib/event-pattern.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
* Events in Amazon CloudWatch Events are represented as JSON objects. For more
* information about JSON objects, see RFC 7159.
*
* **Important**: this class can only be used with a `Rule` class. In particular,
* do not use it with `CfnRule` class: your pattern will not be rendered
* correctly. In a `CfnRule` class, write the pattern as you normally would when
* directly writing CloudFormation.
*
* Rules use event patterns to select events and route them to targets. A
* pattern either matches an event or it doesn't. Event patterns are represented
* as JSON objects with a structure that is similar to that of events, for
* example:
* as JSON objects with a structure that is similar to that of events.
*
* It is important to remember the following about event pattern matching:
*
Expand Down