Skip to main content

Amazon SQS

Use of external data services in AWS will make charges your account. Please make sure to perform the cleanup per the notes at the bottom of the lab.

The following Lab focuses on a quick deployment of an Amazon SQS Queue and then walks through the creation of a resource with Retool Resources.

Requirements​

To configure Amazon SQS the following is required:

  • AWS Account with Administrative user
  • A Retool user created in IAM that has IAM Security Credentials (Access keys) configured

Steps​

Create queue in Amazon SQS​

  • Login to AWS Management Console with a user that has administrative privileges to create Amazon SQS queues.
  • Select Amazon Simple Queue Service (SQS)
  • Select Create queue
  • Leave the default setting to Standard and specify a Name for the queue of RetoolQueue. Scroll to the bottom of the screen and select Create queue
  • This will display queue information for RetoolQueue. Copy the Amazon Resource Name (ARN) of the queue so that you can provide it in the Retool Resource definition.

Create an IAM Role in AWS Identity and Access Management (IAM)​

This required portion of the lab is available as a separate artifact in AWS IAM Role. Complete this first before continuing with the rest of the instructions.

Define Amazon SQS Retool Resource Definition in Retool​

  • Go to Retool Home > Resources.
  • Select Create new > Resource. Enter SQS in search field amd select it.
  • Under Configure SQS enter a name of Retool Event Queue and a description.
  • Select the appropriate region that you created the queue in (e.g., us-east-2).
  • Provide your AWS access key ID and AWS secret key ID for your Retool User in the AWS Account you want to connect to.
  • Specify the AWS IAM Role using the ARN that you want to assume to control the permissions of this user. Use the role created in the previous step, RetoolSQSRole.
  • (Optional) Enter a queue name prefix if you have one.

In Amazon SQS, a queue name prefix is a filtering mechanism that allows you to list or work with multiple queues that share a common prefix in their names. It's not a property of an individual queue but rather a parameter used when querying or accessing queues. For example:

  • If you have queues named "RetoolQueue-dev", "RetoolQueue-test", and "RetoolQueue-prod"
  • You could use "RetoolQueue-" as the prefix to work with all of these queues through a single configuration

This is particularly useful when you need to manage multiple related queues in different environments

Test the Connection​
  • Select Test Connection to confirm the configuration is successful.
  • Select Create Resource to save the changes and make this resource accessible to developers.

Cleanup of Amazon SQS​

The following steps can be used to remove an SQS Topic

  • Go to AWS Management Console, select Amazon SQS > Queues > RetoolQueue > Delete.
  • Go to Retool Home Page > Resources > (select Resource created previously) > … > Delete.