AWS Simple Notification System Component
Available as of Camel version 2.8
The SNS component allows messages to be sent to an Amazon Simple Notification Topic. The implementation of the Amazon API is provided by the http://aws.amazon.com/sdkforjava/[AWS SDK].
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon SNS. More information are available at Amazon SNS.
URI Format
aws-sns://topicNameOrArn[?options]
The topic will be created if they don’t already exists.
You can append query options to the URI in the following format,
?options=value&option2=value&…
URI Options
The AWS Simple Notification System component has no options.
The AWS Simple Notification System endpoint is configured using URI syntax:
aws-sns:topicNameOrArn
with the following path and query parameters:
Path Parameters (1 parameters):
Name | Description | Default | Type |
---|---|---|---|
topicNameOrArn |
Required Topic name or ARN |
String |
Query Parameters (11 parameters):
Name | Description | Default | Type |
---|---|---|---|
accessKey (producer) |
Amazon AWS Access Key |
String |
|
amazonSNSClient (producer) |
To use the AmazonSNS as the client |
AmazonSNS |
|
amazonSNSEndpoint (producer) |
The region with which the AWS-SNS client wants to work with. |
String |
|
headerFilterStrategy (producer) |
To use a custom HeaderFilterStrategy to map headers to/from Camel. |
HeaderFilterStrategy |
|
messageStructure (producer) |
The message structure to use such as json |
String |
|
policy (producer) |
The policy for this queue |
String |
|
proxyHost (producer) |
To define a proxy host when instantiating the SQS client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the SQS client |
Integer |
|
secretKey (producer) |
Amazon AWS Secret Key |
String |
|
subject (producer) |
The subject which is used if the message header 'CamelAwsSnsSubject' is not present. |
String |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
Required SNS component options
You have to provide the amazonSNSClient in the Registry or your accessKey and secretKey to access the Amazon’s SNS.
Usage
Message headers evaluated by the SNS producer
Header | Type | Description |
---|---|---|
|
|
The Amazon SNS message subject. If not set, the subject from the
|
Message headers set by the SNS producer
Header | Type | Description |
---|---|---|
|
|
The Amazon SNS message ID. |
Advanced AmazonSNS configuration
If you need more control over the AmazonSNS
instance configuration you
can create your own instance and refer to it from the URI:
from("direct:start")
.to("aws-sns://MyTopic?amazonSNSClient=#client");
The #client
refers to a AmazonSNS
in the
Registry.
For example if your Camel Application is running behind a firewall:
AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey");
ClientConfiguration clientConfiguration = new ClientConfiguration();
clientConfiguration.setProxyHost("http://myProxyHost");
clientConfiguration.setProxyPort(8080);
AmazonSNS client = new AmazonSNSClient(awsCredentials, clientConfiguration);
registry.bind("client", client);
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version
} must be replaced by the actual version of Camel
(2.8 or higher).