Skip to content

Commit

Permalink
:docs: chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gowrizrh committed Jun 18, 2024
1 parent 0da1e3f commit 39cf0a1
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 3 deletions.
46 changes: 45 additions & 1 deletion MageOS/AsyncEventsAWS/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# MageOS Events integration for AWS
# MageOS Async Events AWS

AWS destinations for [mageos-async-events](https://github.com/mage-os/mageos-async-events)

## Installation

```sh
composer require mage-os/mageos-async-events-aws
```

## Supported AWS event sinks

* EventBridge: send events to an Amazon EventBridge bus

### Configure AWS Credentials

An IAM role with the `events:PutEvents` action is required so that the notifier can relay events into Amazon
EventBridge.

Under `Stores -> Services -> Async Events AWS` set the `Access Key ID` and the `Secret Access Key` and the `Region`. You
can also choose to configure the source of the event.

![AWS Config](./docs/config.png)

### Create a Subscription

The following is an example to create an EventBridge subscription for the `example.event`
```shell
curl --location --request POST 'https://test.mageos.dev/rest/V1/async_event' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"asyncEvent": {
"event_name": "example.event",
"recipient_url": "Amazon Event Bridge ARN",
"verification_token": "supersecret",
"metadata": "eventbridge"
}
}'
```

## Contributing

This is a repository for distribution only.
Contributions are welcome on the development repository [mageos-async-events-sink](https://github.com/mage-os/mageos-async-events-sinks)
Binary file added MageOS/AsyncEventsAWS/docs/config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# mageos-async-events-sinks
This is a mono repository for different event sinks for mageos-async-events.
# MageOS Async Events Sinks

This is the mono repository containing all the different event sinks for MageOS Async Events. For installation
instructions please refer to the individual package's repository.

## Available Event Sinks

### AWS
[mageos-async-events-aws](https://github.com/mage-os/mageos-async-events-aws)
* EventBridge

0 comments on commit 39cf0a1

Please sign in to comment.