Amazon S3 Data Source

Configuring SearchBlox

Before using the Amazon S3 Data Source, install SearchBlox successfully, then create a Custom Collection.


Configuration details of Amazon S3 Data Source**

Accessing Connector UI

encrypted-akEncrypted access key from Amazon s3.
Encrypter would be available in the downloaded archive
encrypted-skEncrypted secret key from Amazon s3.
Encrypter would be available in the downloaded archive
regionRegion of Amazon S3 instance
data-directoryData Folder where the data needs to be stored. Make sure it has write permission.
api-keySearchBlox API Key
colnameThe name of the custom collection in SearchBlox.
queuenameAmazon S3 SQS parameter.
This is required for update of documents after indexing in a bucket.
private-bucketsIf set to true the content from private buckets will be indexed
public-bucketsIf set to true the content from public buckets will be indexed
urlSearchBlox URL
includebucketS3 buckets to be included
include-formatsFile formats to be included
expiring-urlExpiring URLs in the search result. Default URL will be expiring URL
expire-timeDefault expire time will be 300 mins
permanent-url:permanent URLs in the search result. Among the expiring and permanent URL expiring URL is given more preference
max-folder-sizeMaximum size of static folder after which it should be sweeped in MB.
servlet url & delete-api-url:Make sure that the port number is right. If your SearchBlox runs in 8443 port the URLs should be right.

Steps to trigger notification when a document is updated in S3

  1. In Amazon S3 console under services, click on the Simple Queue Service(SQS) which can be found under application integration.
  2. The Select Create New Queue, then give an appropriate queue name and configure the queue.
  1. Set message visibility timeout, retention days and receive message wait time.
  1. Receive message wait time should be set between 1 - 20 seconds. So as to set the queue for long polling.
  2. Then in the S3 console select a bucket whose SQS you need to set and click on “Properties”, Then in “Advanced settings” click on events.
932 929
  1. Now select “Add Notification” and give a name to the notification and check the events for which you need notification.
  1. Then in “Send To” fill SQS Queue and under SQS fill in the name of the queue which we created before and click on Save.
  1. Now, whenever there is change to the documents in this particular bucket then a notification will be sent to SQS.

  2. The queue names need to be given in the S3 connector yml file in order to trigger indexing whenever a document is updated