https://github.com/mage-os/mageos-async-events-aws
This module provides events integrations to AWS.
https://github.com/mage-os/mageos-async-events-aws
adobecommerce aws ecommerce mage-os magento magento2
Last synced: about 1 year ago
JSON representation
This module provides events integrations to AWS.
- Host: GitHub
- URL: https://github.com/mage-os/mageos-async-events-aws
- Owner: mage-os
- License: mit
- Created: 2024-04-29T20:39:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T16:40:50.000Z (over 1 year ago)
- Last Synced: 2025-02-22T11:15:29.470Z (over 1 year ago)
- Topics: adobecommerce, aws, ecommerce, mage-os, magento, magento2
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# MageOS Async Events AWS
AWS event sinks for [mageos-async-events](https://github.com/mage-os/mageos-async-events)
## Installation
```sh
composer require mage-os/mageos-async-events-aws
```
## AWS event sinks
### Amazon EventBridge
**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` and the `Secret Access Key` and the `Region`. You
can also choose to configure the source of the event.
**Create an EventBridge 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"
}
}'
```
### Amazon Simple Queue Service
**Configure AWS Credentials**
An IAM role with the `sqs:SendMessage` action is required so that the notifier can relay events into Amazon
SQS.
Under `Stores -> Services -> Async Events AWS` set the `Access Key` and the `Secret Access Key` and the `Region`.
> [!NOTE]
> The maximum message size for SQS is 262,144 bytes (256 KiB)
**Create an SQS Subscription**
```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 SQS queue URL",
"verification_token": "supersecret",
"metadata": "sqs"
}
}'
```
## Contributing
This is a repository for distribution only.
Contributions are welcome on the development
repository [mageos-async-events-sinks](https://github.com/mage-os/mageos-async-events-sinks)