[BAHIR-233] Add SNS message support for SQS streaming source (#97)

[bahir.git] / sql-streaming-sqs / README.md

diff --git a/sql-streaming-sqs/README.md b/sql-streaming-sqs/README.md
index b0555d6c283c0a85fdf84e1ce8f9108b09a4f124..8dd8a5409a722e0773b554182b4b5795e5906c38 100644 (file)
--- a/sql-streaming-sqs/README.md
+++ b/sql-streaming-sqs/README.md
@@ -63,6 +63,18 @@ shouldSortFiles|true|whether to sort files based on timestamp while listing them
 useInstanceProfileCredentials|false|Whether to use EC2 instance profile credentials for connecting to Amazon SQS
 maxFilesPerTrigger|no default value|maximum number of files to process in a microbatch
 maxFileAge|7d|Maximum age of a file that can be found in this directory
+messageWrapper|None| - 'None' if SQS contains plain S3 message. <br/> - 'SNS' if SQS contains S3 notification message which came from SNS. <br/> Please see 'Use multiple consumers' section for more details 
+
+## Use multiple consumers
+
+SQS cannot be read by multiple consumers. <br/> 
+If S3 path should be listen by multiple applications the following approach is recommended: S3 -> SNS -> SQS:
+1. Create multiple SQS queues. Each application listen for one SQS queue.
+2. Create 1 SNS topic
+3. Once S3 notification event is pushed to SNS topic it will be delivered to each SQS queue 
+
+Thus, one S3 path can be processed by multiple applications. <br/>
+ 
 
 ## Example