https://github.com/symfony/amazon-sns-notifier
Provides Amazon SNS integration for Symfony Notifier.
https://github.com/symfony/amazon-sns-notifier
amazon chat component notifier php sms sns symfony symfony-component
Last synced: 5 months ago
JSON representation
Provides Amazon SNS integration for Symfony Notifier.
- Host: GitHub
- URL: https://github.com/symfony/amazon-sns-notifier
- Owner: symfony
- License: mit
- Created: 2021-07-26T17:26:57.000Z (over 4 years ago)
- Default Branch: 7.2
- Last Pushed: 2025-01-29T07:43:07.000Z (about 1 year ago)
- Last Synced: 2025-01-29T14:23:30.160Z (about 1 year ago)
- Topics: amazon, chat, component, notifier, php, sms, sns, symfony, symfony-component
- Language: PHP
- Homepage: https://symfony.com/notifier
- Size: 57.6 KB
- Stars: 6
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Amazon Notifier
===============
Provides [Amazon SNS](https://aws.amazon.com/en/sns/) integration for Symfony Notifier.
DSN example
-----------
```
AMAZON_SNS_DSN=sns://ACCESS_ID:ACCESS_KEY@default?region=REGION&profile=PROFILE&sslmode=SSLMODE
```
where:
- `ACCESS_ID` is your AWS access key id
- `ACCESS_KEY` is your AWS access key secret
- `REGION` is the targeted AWS region (optional, default: `us-east-1`)
- `PROFILE` is the name of your AWS configured profile (optional, default: `default`)
- `SSLMODE` `https` is used by default. It can be changed by setting value to `disable`,
`http` will be used
Adding Options to a Chat Message
--------------------------------
With an Amazon SNS Chat Message, you can use the `AmazonSnsOptions` class to add
message options.
```php
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsOptions;
$chatMessage = new ChatMessage('Contribute To Symfony');
$options = (new AmazonSnsOptions('topic_arn'))
->subject('subject')
->messageStructure('json')
// ...
;
// Add the custom options to the chat message and send the message
$chatMessage->options($options);
$chatter->send($chatMessage);
```
Resources
---------
* [AsyncAws Documentation](https://async-aws.com/configuration.html)
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
* [Report issues](https://github.com/symfony/symfony/issues) and
[send Pull Requests](https://github.com/symfony/symfony/pulls)
in the [main Symfony repository](https://github.com/symfony/symfony)