Connect a Postgres, MySQL, or SQL Server database hosted on AWS

AWS supports a number of database types (Postgres, MySQL, SQL Server, etc.). The instructions for each database type are the same. If your database is clustered, you will need to find the specific instance within the cluster you want to connect to.

Finding the database in AWS

All of the following sections start from the database instance page in AWS. To find this:

  1. Head to the RDS homepage by typing RDS in the search box at the top of the AWS console.
  2. Ensure you are in the correct region in the top right (Virginia, Ohio, etc.)
  3. Select the database you want to connect to from the list. If your database is part of a cluster, choose the specific instance within the cluster that you want to connect to.

Finding connection details

You need five pieces of information to connect a database to Equals: host, port, username, password, database password.

Host & Port

  1. Find your database in AWS (first section above).
  2. On this page, you can find the endpoint – which is the host – and port in the Connectivity & security section:

Username, Password, Database name

AWS only gives you the username and password for your database on creation, and the database name is set by you after creation. If you don’t have these details contact the person on your team that set up the database.

Allowing access from our IP

You likely need to allow incoming connections from Equals’ IP address. There are two parts to enabling access from outside AWS: turning on public access and adding a security group rule.

Turning on “public access”

  1. Find your database in AWS (first section above).

  2. On the database details page ensure that Publicly accessible is Yes under Security. If it is, continue with the next section.

  3. If Publicly accessible is set to No, click Modify in the top right.

  4. Scroll down to the Connectivity section and expand the Additional configuration subsection. Here you can enable public access:

  5. Head to the bottom of the page and click Continue

  6. Choose Apply immediately under Schedule modifications

  7. Save your changes by clicking Modify DB instance, the changes will be applied in a couple of minutes.

Note: you can still deny public access from all non-Equals IPs with security group rules.

Adding a security group rule

  1. Find your database in AWS (first section above).
  2. Under the “Security” subsection within Connectivity & security click the security group. If the database is part of multiple security groups you should choose one specific to just this database – or create one if it doesn’t exist.
  3. Once on the security group page, click Inbound rules in the tab bar and then Edit inbound rules.
  4. On the Edit inbound rules page click Add rule.
  5. Choose Custom TCP for Type and enter the port for your database under Port range.
  6. For Source, choose Custom and then enter Equals’ IP address in the text field:
  7. Click Save rules. Equals should now be able to connect to your database.