Connecting Amazon RDS

Amazon Relational Database Services (RDS) is a managed database service that runs on database engines that you're probably already familiar with - MySQL, Microsoft SQL, and PostgreSQL.

The steps for connecting your RDS instance vary slightly depending on the type of database you're using (use the links above for detailed instructions for each database), and whether or not you're using an encrypted connection (like an SSH tunnel for MySQL), but here's the gist of it:

Authorize Magento BI to access your database

On the credentials page (Manage Data > Integrations) for each database, you'll see a box containing the IP addresses you'll need to authorize to connect RDS to Magento BI: and Here's a look at the MySQL credentials page, where we highlighted the IP address box:

For Magento BI to successfully connect with your RDS instance, you'll need to add these IP addresses to the appropriate database security group via the AWS management console. These IP addresses can be added to an existing group or you can create a new one - the important thing is that the group is authorized to access the instance you want to connect to Magento BI.

When adding the Magento BI IP addresses, make sure you add a "/32" to the end of the address to indicate to Amazon that it is an exact IP address. Don't worry; the AWS interface will make it clear that this is required.

Create a Linux user for Magento BI

This step is only required if you're using an encrypted connection. For instructions on how to do this, refer to the setup article for the database you're using (ex: MySQL). The Linux user will allow us to create an SSH tunnel, which is the safest method of sending data over the internet.

Create a database user for Magento BI

This is the part of the process where, depending on the database you're using, the steps will vary. The idea is the same, though: you'll create a user for Magento BI which will be used to access your database. Instructions for creating a database Magento BI user can be found in the setup article for the database you're using.

Enter connection info into Magento BI

After you've granted Magento BI access to your instance and created a user for us, the last thing you'll need to do is enter the connection info into Magento BI.

The credential pages for MySQL, Microsoft SQL, and PostgreSQL are accessed via the Integrations page (Manage Data > Integrations) by clicking the Add Integration button. When the list of integrations displays, click the icon for the database you're using to go to the credentials page. If you do not currently have access to the integration you need, contact your CSM.

To finish creating the connection, we'll need the following info:

  • The public address of your RDS instance. This can be found in the AWS management console.
  • The port your database instance uses. Some databases have a default port, which will automatically populate the Port field. This info can also be found in our setup documentation for the database.
  • The username and password of the user you created for Magento BI

Additionally, if you're using an encrypted connection, toggle the Encrypted button on the database credentials page to Yes. This will display an additional form for setting up the encryption:

That's all there is to it! Connecting your RDS instance is complete.