Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boyney123/cdk-eventbridge-socket
CDK construct that creates a WebSocket endpoint for you for any EventBridge rule you are interested in. (Built for debugging + testing )
https://github.com/boyney123/cdk-eventbridge-socket
aws aws-construct aws-constructs awscdk cdk cdk-examples eventbridge
Last synced: 1 day ago
JSON representation
CDK construct that creates a WebSocket endpoint for you for any EventBridge rule you are interested in. (Built for debugging + testing )
- Host: GitHub
- URL: https://github.com/boyney123/cdk-eventbridge-socket
- Owner: boyney123
- Created: 2021-08-24T19:19:21.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T21:37:52.000Z (about 2 years ago)
- Last Synced: 2024-11-02T06:30:49.609Z (5 days ago)
- Topics: aws, aws-construct, aws-constructs, awscdk, cdk, cdk-examples, eventbridge
- Language: HTML
- Homepage: https://boyney123.github.io/cdk-eventbridge-socket/
- Size: 566 KB
- Stars: 53
- Watchers: 4
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-eventbridge - cdk-eventbridge-socket - CDK construct that creates a WebSocket endpoint for you for any EventBridge rule you are interested in. (Built for debugging + testing ) (Tools)
README
# [cdk-eventbridge-socket](https://boyney123.github.io/cdk-eventbridge-socket/)
This is an AWS CDK Construct that will listen for any EventBridge Bus and Rule and forward that event through a websocket.
**Get setup in seconds and as easy as 7 lines of code.**
### Why
You may want to use tools like [Postman Websockets](https://blog.postman.com/postman-supports-websocket-apis/) or [websocat](https://github.com/vi/websocat) to see and debug what events are being fired through your event bus.
### How
This uses AWS ApiGateway, DynamoDB (to store connections) and Lambda.
## Installation and Usage
### Typescript
```console
npm install --save cdk-eventbridge-socket
```
```typescript
import * as cdk from '@aws-cdk/core';
import { EventBridgeWebSocket } from 'cdk-eventbridge-socket';
export class EventbridgeWebhooksStack extends cdk.Stack {
constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
super(scope, id, props);
new EventBridgeWebSocket(this, 'sockets', {
bus: 'your-event-bus-name',
// This example shows how to listen for all events
eventPattern: {
account: ['your_account_id'],
},
stage: 'dev',
});
}
}
```
When using the `cdk-eventbridge-socket` the new websocket url will be output on your terminal.
## Usage
There are only a few properties you have to set `bus`, `eventPattern` and `stage`.
You can listen to any EventBridge source/pattern you like, just replace the `eventPattern` with what you want to listen to.
#### Examples
##### Listen for a detailType
```typescript
new EventBridgeWebSocket(this, 'sockets', {
bus: 'your-event-bus-name',
// Listens for all UserCreated events
eventPattern: {
detailType: ['UserCreated'],
},
stage: 'dev',
});
```
##### Listen for a source
```typescript
new EventBridgeWebSocket(this, 'sockets', {
bus: 'your-event-bus-name',
// Listens for all events on source
eventPattern: {
source: ['myapp.users'],
},
stage: 'dev',
});
```
You can find more [here on the AWS documentation](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.EventPattern.html)
# Contributing
If you have any questions, features or issues please raise any issue or pull requests you like. I will try my best to get back to you.
# License
MIT.