[[AWS-SNS-SNSComponent]]
SNS Component
~~~~~~~~~~~~~

*Available as of Camel 2.8*

The SNS component allows messages to be sent to an
http://aws.amazon.com/sns[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
http://aws.amazon.com/sns[Amazon SNS].

[[AWS-SNS-URIFormat]]
URI Format
^^^^^^^^^^

[source,java]
-----------------------------
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&...`

[[AWS-SNS-URIOptions]]
URI Options
^^^^^^^^^^^

[width="100%",cols="10%,10%,10%,70%",options="header",]
|=======================================================================
|Name |Default Value |Context |Description

|amazonSNSClient |`null` |Producer |Reference to a `com.amazonaws.services.sns.AmazonSNS` in the
link:registry.html[Registry].

|accessKey |`null` |Producer |Amazon AWS Access Key

|secretKey |`null` |Producer |Amazon AWS Secret Key

|subject |`null` |Producer |The subject which is used if the message header 'CamelAwsSnsSubject' is
not present.

|amazonSNSEndpoint |`null` |Producer |The region with which the AWS-SNS client wants to work with.

|policy |`null` |Producer |*Camel 2.8.4*: The policy for this queue to set in the
`com.amazonaws.services.sns.model.SetTopicAttributesRequest`.

|proxyHost |`null` |Producer |*Camel 2.16*: Specify a proxy host to be used inside the client
definition.

|proxyPort |`null` |Producer |*Camel 2.16*: Specify a proxy port to be used inside the client
definition.
|=======================================================================

Required SNS component options

You have to provide the amazonSNSClient in the
link:registry.html[Registry] or your accessKey and secretKey to access
the http://aws.amazon.com/sns[Amazon's SNS].

[[AWS-SNS-Usage]]
Usage
^^^^^

[[AWS-SNS-MessageheadersevaluatedbytheSNSproducer]]
Message headers evaluated by the SNS producer
+++++++++++++++++++++++++++++++++++++++++++++

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Header |Type |Description

|`CamelAwsSnsSubject` |`String` |The Amazon SNS message subject. If not set, the subject from the
`SnsConfiguration` is used.
|=======================================================================

[[AWS-SNS-MessageheaderssetbytheSNSproducer]]
Message headers set by the SNS producer
+++++++++++++++++++++++++++++++++++++++

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Header |Type |Description

|`CamelAwsSnsMessageId` |`String` |The Amazon SNS message ID.
|=======================================================================

[[AWS-SNS-AdvancedAmazonSNSconfiguration]]
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:

[source,java]
-------------------------------------------------
from("direct:start")
.to("aws-sns://MyTopic?amazonSNSClient=#client");
-------------------------------------------------

The `#client` refers to a `AmazonSNS` in the
link:registry.html[Registry].

For example if your Camel Application is running behind a firewall:

[source,java]
--------------------------------------------------------------------------------------
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);
--------------------------------------------------------------------------------------

[[AWS-SNS-Dependencies]]
Dependencies
^^^^^^^^^^^^

Maven users will need to add the following dependency to their pom.xml.

*pom.xml*

[source,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).

[[AWS-SNS-SeeAlso]]
See Also
^^^^^^^^

* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
* link:getting-started.html[Getting Started]

* link:aws.html[AWS Component]

