SNS (Simple Notification Service)¶
This document contains information about the SNS service supported in Handel. This Handel service provisions an SNS topic for use by your applications.
|type||string||Yes||This must always be sns for this service type.|
|subscriptions||Subscriptions||No||An optional list of statically-defined subscriptions. You can also dynamically add subscriptions in your application code.|
The Subscription element is defined by the following schema:
subscriptions: - endpoint: <string> protocol: <http|https|email|email-json|sms>
See the SNS subscription documentation for full details on configuring endpoints and protocols.
Protocols sqs, application, and lambda are supported through Service Events.
Example Handel File¶
This Handel file shows an SQS service being configured:
version: 1 name: my-sns-topic environments: dev: topic: type: sns subscriptions: - endpoint: firstname.lastname@example.org protocol: email
Depending on this service¶
This service outputs the following environment variables:
|<ENV_PREFIX>_TOPIC_ARN||The AWS ARN of the created topic|
|<ENV_PREFIX>_TOPIC_NAME||The name of the created topic|
The <ENV_PREFIX> is a consistent prefix applied to all information injected for service dependencies. See Environment Variable Prefix for information about the structure of this prefix.
Events produced by this service¶
The SNS service currently produces events for the following services types:
Events consumed by this service¶
The SNS service does not currently consume events from other Handel services.