sns egress connector

SNS Egress Connector

Version: 17.07

Supported Since: 17.07

What is SNS Egress Connector?

SNS Egress Connector can be used to publish notifications to Amazon AWS SNS topics.

AWS SNS credentials associated with an account which has write permission to the target bucket will be necessary when configuring this connector.
In order to use the SNS Egress Connector, you must first select the AWS Connector dependency from the connector list when you are creating an empty Ultra project. If you have already created a project, you can add the AWS Connector dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list, select the AWS Connector dependency.
sns egress ports

Out Ports

On Exception

The message will be emitted from this out port if the processing element fails to publish the message content to target SNS topic.

Response Processor

The message will be sent to this out port if the Complete Flow property is disabled and the message has been sent to the SNS topic successfully

Side Ports

Connector Operation

This port is used to connect operational elements to the Egress Connector. By-default, user does not have to connect any operational element and the default connector operation will be used.


* marked fields are mandatory

SNS Region *


The region of the target SNS topic

Topic ARN(Amazon resource name) *


Name of the AWS SNS topic, which is located in the configured AWS SNS region.

Use profile Credentials


If selected, profile credentials will be used, credentials will be picked from ~/.aws/credentials (Linux/Mac) or C:\Users\USER_NAME\.aws\credentials (Windows)

AWS Access Key Id


AWS Access Key Id is required only if profile credentials are not going to be used.

AWS Access Secret Key


AWS Access Secret Key is required only if profile credentials are not going to be used.

Message Structure


Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

  • be a syntactically valid JSON object

  • contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., http). For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

Sample Use Case

ABC is a news company, which delivers news to it’s customers via digital media. Users can access news published by ABC using following mediums,

  • ABC news mobile app

  • ABC news mailing list

  • SMS

ABC uses following integration flow to achieve above requirement with AWS simple notification service.

sns egress flow
Figure 1. Integration Flow
sns egress flow config
Figure 2. SNS Egress connector configuration

In this case, connector has configured to use JSON format, so it expects a JSON payload of following format.

'default':'News to be sent to mobile apps',
'email' :'New to be sent to email subscribers',
'sms':'News to be sent to sms subscribers'

Product and company names and marks mentioned are the property of their respective owners and are mentioned for identification purposes only.

In this topic
In this topic
Contact Us