Reltio Connector for Amazon SQS
Reltio recommends that you use the Reltio-provided connector for Amazon SQS instead of the available connectors to build recipes.
The Reltio connector for Amazon SQS provides an enhancement over the Reltio Integration Hub default Amazon SQS connector for the security and performance of batch data. Reltio connector for SQS allows you to connect to Reltio platform queues within the security roles defined by Reltio for your queues. For more information about Amazon SQS, see Amazon Simple Queue Service.
To use the connector, you must first set up a connection. You can view the available connections on the Reltio Integration Hub.
Provision IAM Users
- Connection name: Enter a unique name that identifies the S3 instance the connection is connected to.
- IAM role ARN: Create an Amazon Resource Name (ARN) for the user.
- Region: Enter the queue region defined in the queue ARN.
- Version: Enter the version as 2012-11-05.
- Service: Enter the queue service defined in the queue ARN.Note: If your queue ARN is arn:aws:sqs-fips:us-east-1:641923904298:gabriel_standard_q, use sqs-fips as the service.
- Queue URL: Copy the queue URL from the SQS management console or the URL provided by Reltio support while provisioning the queue for your tenant.
Create a Recipe for the Connection
- Provide a name for the connection.
- Select the connector.
- Select New Message to trigger a connection for a single message, or New Messages to trigger a connection for a batch.
- Click Create connection or use the existing connection created earlier.
- For a new connection, provide the values in the following fields:
- Connection name: Enter a unique name that identifies the S3 instance that the connection is connected to.
- Access key Id: Enter the ID of the IAM user.
- Secret access key: Enter the secret access key of the IAM user.
- Region: Enter the queue region defined in the queue ARN.
- Version: Enter the version as 2012-11-05.
- Service: Enter the queue service defined in the queue ARN.Note: If your queue ARN is arn:aws:sqs-fips:us-east-1:641923904298:gabriel_standard_q, use the sqs-fips service.
- Queue URL: Copy the queue URL from the SQS management console.
- Click Connect.
You can also set an optional trigger condition if you only want to process messages based on specific conditions by enabling the Set trigger condition toggle key.
- Click Save.
Action Triggers for New Messages
- Poll trigger for a single message: This trigger reads a maximum number of 10 messages from the queue. For each message in the queue, the connector generates one event, and if 10 messages are retrieved from the queue, then 10 events are generated. As a result, 10 jobs are created.
- Poll trigger for a batch: This trigger reads a maximum number of 2000 messages in a batch. The connector reads messages from the queue using multiple parallel requests. For each batch, the connector generates a single event that contains all messages. A single job that contains 2000 messages is created.
By default, both triggers do not remove messages from the queue, although messages are automatically hidden from subsequent requests. If you want to delete retrieved messages from the queue, you can select the Auto Delete trigger parameter. You can set this optional parameter while creating a recipe. It is available in the optional fields available section.
- Send message: This action delivers a message to the specified queue.
- Delete message: This action deletes a message from the specified queue.
- Receive message: This action receives messages from the specified queue.