Prerequisites

• The Amazon RDS MySQL instance is running.

• The MySQL version is 8.0 or higher. You can choose the MySQL version while creating the instance.

• Binary Log (BinLog) replication is enabled on the Amazon RDS MySQL database server.

• Hevo’s IP address(es) for your region is added to the Amazon RDS MySQL database IP Allowlist.

• The SELECT, RELOAD, SHOW DATABASES, and REPLICATION privileges are granted to the database user.

  Note: We recommend that you create a database user for configuring your Amazon RDS MySQL Source in Hevo. However, if you already have one, refer to section Grant privileges to the user.

• The database hostname and port number of the Source instance are available.

---

Perform the following steps to configure your Amazon RDS MySQL Source:

Create a Read Replica (Optional)

---

Set up MySQL Binary Logs for Replication

A binary log is a collection of log files that records information about data modifications and data object modifications made on a MySQL server instance. Typically binary logs are used for data replication and data recovery.

In order for the binary log to record the data modifications, automatic backups must be enabled with a duration of at least 1 day.

To enable binary logging, follow these steps:

1. Configure the parameter group

1. Open the Amazon RDS console.

2. In the left navigation pane, click Databases (or Instances if you are using an older version).

3. In the Databases section on the right, click the DB instance that you want to connect.

   

4. Click the Configuration tab, and then click the link text under DB instance parameter group. If you have created the parameter group with Type as DB cluster parameter group, click the link text under DB cluster parameter group.

   

5. Click Edit.

   

6. Update the values of the parameters as follows:

   

   Parameter Name	Value
   binlog_format	ROW
   binlog_row_image	full
   gtid-mode	ON
   enforce_gtid_consistency	ON
   log_slave_updates	1

   Note:

   • The log_slave_updates setting is required only if you are connecting to a read replica. When it is set to 1, the replica logs any updates received from the main database, maintaining a record of those changes in its log.

   • Enabling GTID is recommended because it makes replication simpler and helps ensure that the primary and replica servers are in sync with each other.

   • Ensure that the value of binlog_row_value_options parameter is not set to PARTIAL_JSON.

7. Click Save changes.

8. Reboot the database instance that you are using to connect to Hevo, to apply the above changes.

   To do this:

   1. In the left navigation pane, under Dashboard, select Databases.

   2. In the Databases section on the right, select the DB identifier of the MySQL instance you are replicating.

   3. In the Actions drop-down, click Reboot.

      

   4. On the Reboot DB Instance page, click Confirm to reboot your DB instance.

      

The replication reference guide on MySQL’s documentation portal provides a complete reference of the options available for replication and binary logging.

2. Enable Automatic Backups

1. In the Amazon RDS console, in the left navigation pane, click Databases (or Instances if you are using an older version).

2. In the Databases section on the right, select the instance for which you want to enable automatic backups, and then click Modify.

   

3. On the Modify DB Instance: <Instance name> page, scroll down to the Backup section.

4. Select the Enable automated backups check box and set the Backup retention period to any value greater than or equal to 1 day. A backup retention period of at least 3 days is recommended.

   

5. Click Continue.

6. Under the Schedule modifications panel, select Apply immediately, and then click Modify DB instance.

   

3. Configure the BinLog retention period

1. Log in to your Amazon RDS MySQL database instance with ADMIN privileges.

2. Run the following command to view the current BinLog retention period (in hours):

   call mysql.rds_show_configuration;
   

3. If the BinLog retention period is less than 72 hours, run the following command to set it to at least 72 hours (three days).

   call mysql.rds_set_configuration('binlog retention hours', 72);
   

---

Allowlist Hevo IP addresses for your region

You need to allowlist the Hevo IP address for your region to enable Hevo to connect to your Amazon RDS MySQL database.

To do this:

1. Open the Amazon RDS console.

2. In the left navigation pane, click Databases (or Instances if you are using an older version).

3. In the Databases section on the right, click the DB identifier of the Amazon RDS MySQL instance to configure a security group.

   

   Note: The instance does not necessarily have to be a replica as long as it allowlists the region’s IP addresses.

4. In the Connectivity & security tab:

   

   • Note the region where your account is set up, using the Hevo App URL also. For example, the URL for the US region is https://us.hevodata.com/.

   • Click the link text under Security, VPC security groups to open the Security Groups panel.

5. Select the security group and then select Edit inbound rules from the Actions drop-down.

   

6. On the Edit inbound rules page:

   1. Click Add rule.

   2. In the Port range column, enter the port of your Amazon RDS MySQL instance. For example, 3306.

   3. In the Source column, select Custom from the drop-down and enter Hevo’s IP addresses for your region.

   4. Click Save rules.

      

---

Create a Database User and Grant Privileges

1. Create a database user (Optional)

2. Grant privileges to the user

The database user specified in the Hevo Pipeline must have the following global privileges:

• SELECT - Select data from tables in your database which you want to replicate.

• RELOAD - Access to clear or reload internal caches, flush tables, or acquire locks.

• SHOW DATABASES - View list of database names in the server.

• REPLICATION CLIENT - Access to the MySQL server BinLog for replication.

• REPLICATION SLAVE - Access replication status and log details.

Note: The SELECT, RELOAD, and SHOW DATABASES privileges are only required during the historical load.

Perform the following steps to set up these privileges:

1. Connect to your Amazon RDS MySQL database as a root user with an SQL client tool, such as MySQL workbench.

2. Grant the required privileges to the user:

   GRANT SELECT, RELOAD, SHOW DATABASES, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO <username>@'%';
   

3. Allow Hevo to access your database:

   GRANT SELECT ON <database_name>.* TO <username>;
   

4. Grant privileges to the database user to read BinLog settings:

   GRANT EXECUTE ON PROCEDURE mysql.rds_show_configuration TO '<username>'@'<hostname>';
   

5. Finalize the user’s permissions:

   FLUSH PRIVILEGES;
   

Note: Replace the placeholder values in the commands above with your own. For example, <username> with hevo.

---

Retrieve the Database Hostname and Port Number (Optional)

---