eventbridge-cli

command module
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2020 License: BSD-3-Clause Imports: 17 Imported by: 0

README

logo eventbridge-cli

Release Actions Status

Amazon EventBridge is a serverless event bus that makes it easy to connect applications together using data from your own applications, integrated Software-as-a-Service (SaaS) applications, and AWS services.

Eventbridge-cli is a tool to listen to an EventBus events. Useful for debugging and event pattern testing.

EventBus --> EventBrige Rule --> SQS <-- poller

Features:

  • Listen to Event Bus messages
  • Filter messages by event pattern
  • Read event pattern from cli or file
  • Authentication via profile or env variables
  • Pretty JSON output
  • ...
Install from releases binary:
wget https://github.com/spezam/eventbridge-cli/releases/download/<version>/eventbridge-cli_<version>_darwin_amd64.tar.gz
tar xvfz eventbridge-cli_<version>_darwin_amd64.tar.gz
mv eventbridge-cli /somewhere/in/PATH
with go install
GOBIN=$PWD/bin GO111MODULE=on go install github.com/spezam/eventbridge-cli
or build from source:
go build
Flags:
NAME:
   eventbridge-cli - AWS EventBridge cli

USAGE:
   eventbridge [global options] command [command options] [arguments...]

VERSION:
   1.0.0

AUTHOR:
   matteo ridolfi

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --profile value, -p value       AWS profile (default: "default") [$AWS_PROFILE]
   --region value, -r value        AWS region [$AWS_DEFAULT_REGION]
   --eventbusname value, -b value  EventBridge Bus Name (default: "default")
   --eventpattern value, -e value  EventBridge event pattern. If prefixed with 'file://', a file will be used (default: "{\"source\": [{\"anything-but\": [\"eventbridge-cli\"]}]}")
   --prettyjson, -j                Pretty JSON output (default: false)
   --help, -h                      show help (default: false)
   --version, -v                   print the version (default: false)
Usage example:
# with env variables
AWS_PROFILE=myawsprofile eventbridge-cli
AWS_PROFILE=myawsprofile AWS_DEFAULT_REGION=eu-north-1 eventbridge-cli

# with cli flags
eventbridge-cli --profile myawsprofile
eventbridge-cli --profile myawsprofile --region eu-north-1

# with event pattern
eventbridge-cli -p myawsprofile -j \
	-b fishnchips-eventbus \
	-e '{"source":["gamma"],"detail":{"channel":["web"]}}'

# with event pattern from file in testdata/eventpattern.json
eventbridge-cli -p myawsprofile -j \
	-b fishnchips-eventbus \
	-e file://testdata/eventpattern.json

screenshot

Content-based Filtering with Event Patterns reference:

https://docs.aws.amazon.com/eventbridge/latest/userguide/content-filtering-with-event-patterns.html

Here is a summary of all the comparison operators available in EventBridge:

Comparison Example Rule syntax
Null UserID is null "UserID": [ null ]
Empty LastName is empty "LastName": [""]
Equals Name is "Alice" "Name": [ "Alice" ]
And Location is "New York" and Day is "Monday" "Location": [ "New York" ], "Day": [ "Monday" ]
Or PaymentType is "Credit" or "Debit" "PaymentType": [ "Credit", "Debit" ]
Not Weather is anything but "Raining" "Weather": [{ "anything-but": [ "Raining" ] }]
Numeric (equals) Price is 100 "Price": [{ "numeric": [ "=", 100 ] }]
Numeric (range) Price is more than 10, and less than or equal to 20 "Price": [{ "numeric": [ ">", 10, "<=", 20 ] }]
Exists ProductName exists "ProductName": [{ "exists": true }]
Does not exist ProductName does not exist "ProductName": [{ "exists": false }]
Begins with Region is in the US "Region": [{ "prefix": "us-" }]

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL