SNS Component
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.
Info | ||
---|---|---|
| ||
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
Code Block |
---|
aws-sns://topicName[?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
Name | Default Value | Context | Description |
---|---|---|---|
amazonSNSClient | | Producer | Reference to a |
accessKey | | Producer | Amazon AWS Access Key |
secretKey | | Producer | Amazon AWS Secret Key |
subject | | Producer | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. |
amazonSNSEndpoint | | Producer | The region with which the AWS-SNS client wants to work with. |
policy | | Producer | Camel 2.8.4: The policy for this queue to set in the |
Info | ||
---|---|---|
| ||
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
Wiki Markup |
---|
{div:class=confluenceTableSmall} || Header || Type || Description || | {{CamelAwsSnsSubject}} | {{String}} | The Amazon SNS message subject. If not set, the subject from the {{SnsConfiguration}} is used. | {div} |
Message headers set by the SNS producer
Wiki Markup |
---|
{div:class=confluenceTableSmall} || Header || Type || Description || | {{CamelAwsSnsMessageId}} | {{String}} | The Amazon SNS message ID. | {div} |
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:
Code Block |
---|
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:
Code Block |
---|
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.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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).
Include Page | ||||
---|---|---|---|---|
|