AWS SNS Component

Table of Contents

URI Format
URI Options
Usage
Dependencies
See Also

Available as of Camel 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 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 component supports 11 endpoint options which are listed below:

{% raw %}

Name	Group	Default	Java Type	Description
topicNameOrArn	producer		`String`	Required Topic name or ARN
accessKey	producer		`String`	Amazon AWS Access Key
amazonSNSClient	producer		`AmazonSNS`	To use the AmazonSNS as the client
amazonSNSEndpoint	producer		`String`	The region with which the AWS-SNS client wants to work with.
messageStructure	producer		`String`	The message structure to use such as json
policy	producer		`String`	The policy for this queue
proxyHost	producer		`String`	To define a proxy host when instantiating the SQS client
proxyPort	producer		`Integer`	To define a proxy port when instantiating the SQS client
secretKey	producer		`String`	Amazon AWS Secret Key
subject	producer		`String`	The subject which is used if the message header 'CamelAwsSnsSubject' is not present.
synchronous	advanced	`false`	`boolean`	Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

{% endraw %}

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

Table of Contents

Message headers evaluated by the SNS producer
Message headers set by the SNS producer
Advanced AmazonSNS configuration

Message headers evaluated by the SNS producer

Header	Type	Description
`CamelAwsSnsSubject`	`String`	The Amazon SNS message subject. If not set, the subject from the `SnsConfiguration` is used.

Message headers set by the SNS producer

Header	Type	Description
`CamelAwsSnsMessageId`	`String`	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).