Update wiki Home page for aws2-sns

Home.md

@@ -1,21 +1,55 @@
-# Deploy the Project on CamelX Platform
+# AWS Simple Notification System (SNS)
 
-Deploy on CamelX Platform in three steps
+Send messages to AWS Simple Notification Topic.
 
-## Step 1: Create a release
+## Metadata
-From the project space, click on **"Create a release"**
 
-The new version is automatically available in the list
+| Property | Value |
+|----------|-------|
+| Scheme | `aws2-sns` |
+| Support Level | Stable |
+| Labels | cloud,messaging,mobile |
+| Version | 4.10.2 |
 
-## Step 2: Deploy
+## Maven Dependency
-Click on **"Deploy"**
 
-- **Version:** Select the desired release
+```xml
-- **Environment:** Choose `Development`, `Staging`, or `Production` 
+<dependency>
-- **Configuration:** Select the configuration source
+    <groupId>org.apache.camel</groupId>
-- **Resources:** Set CPU and Memory
+    <artifactId>camel-aws2-sns</artifactId>
+    <version>4.10.2</version>
+</dependency>
+```
 
-## Step 3: Expose
+## Endpoint Properties
-Enable **"Expose"**
 
-Choose an **API Gateway** (Internal, Public, etc.)
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `topicNameOrArn` | string | ✓ |  | Topic name or ARN |
+| `autoCreateTopic` | boolean |  | `false` | Setting the auto-creation of the topic |
+| `headerFilterStrategy` | object |  |  | To use a custom HeaderFilterStrategy to map headers to/from Camel. |
+| `kmsMasterKeyId` | string |  |  | The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. |
+| `messageDeduplicationIdStrategy` | string |  | `useExchangeId` | Only for FIFO Topic. Strategy for setting the messageDeduplicationId on the message. It can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. |
+| `messageGroupIdStrategy` | string |  |  | Only for FIFO Topic. Strategy for setting the messageGroupId on the message. It can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsSnsMessageGroupId will be used. |
+| `messageStructure` | string |  |  | The message structure to use such as json |
+| `overrideEndpoint` | boolean |  | `false` | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option |
+| `policy` | string |  |  | The policy for this topic. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |
+| `queueArn` | string |  |  | The ARN endpoint to subscribe to |
+| `region` | string |  |  | The region in which the SNS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id() |
+| `serverSideEncryptionEnabled` | boolean |  | `false` | Define if Server Side Encryption is enabled or not on the topic |
+| `subject` | string |  |  | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. |
+| `subscribeSNStoSQS` | boolean |  | `false` | Define if the subscription between SNS Topic and SQS must be done or not |
+| `uriEndpointOverride` | string |  |  | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option |
+| `lazyStartProducer` | boolean |  | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
+| `amazonSNSClient` | object |  |  | To use the AmazonSNS as the client |
+| `proxyHost` | string |  |  | To define a proxy host when instantiating the SNS client |
+| `proxyPort` | integer |  |  | To define a proxy port when instantiating the SNS client |
+| `proxyProtocol` | object |  | `HTTPS` | To define a proxy protocol when instantiating the SNS client |
+| `accessKey` | string |  |  | Amazon AWS Access Key |
+| `profileCredentialsName` | string |  |  | If using a profile credentials provider, this parameter will set the profile name |
+| `secretKey` | string |  |  | Amazon AWS Secret Key |
+| `sessionToken` | string |  |  | Amazon AWS Session Token used when the user needs to assume an IAM role |
+| `trustAllCertificates` | boolean |  | `false` | If we want to trust all certificates in case of overriding the endpoint |
+| `useDefaultCredentialsProvider` | boolean |  | `false` | Set whether the SNS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. |
+| `useProfileCredentialsProvider` | boolean |  | `false` | Set whether the SNS client should expect to load credentials through a profile credentials provider. |
+| `useSessionCredentials` | boolean |  | `false` | Set whether the SNS client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SNS. |