> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Step-by-step guide on how to set up Amazon RDS MySQL as a source for ClickPipes
# RDS MySQL source setup guide
export const Image = ({img, alt, size}) => {
return
;
};
This step-by-step guide shows you how to configure Amazon RDS MySQL to replicate data into ClickHouse Cloud using the [MySQL ClickPipe](/integrations/clickpipes/mysql). For common questions around MySQL CDC, see the [MySQL FAQs page](/integrations/clickpipes/mysql/faq).
Enable binary log retention
The binary log is a set of log files that contain information about data modifications made to an MySQL server instance, and binary log files are required for replication. To configure binary log retention in RDS MySQL, you must [enable binary logging](#enable-binlog-logging) and [increase the binlog retention interval](#binlog-retention-interval).
1. Enable binary logging via automated backup
The automated backups feature determines whether binary logging is turned on or off for MySQL. Automated backups can be configured for your instance in the RDS Console by navigating to **Modify** > **Additional configuration** > **Backup** and selecting the **Enable automated backups** checkbox (if not selected already).
We recommend setting the **Backup retention period** to a reasonably long value, depending on the replication use case.
2. Increase the binlog retention interval
If ClickPipes tries to resume replication and the required binlog files have been purged due to the configured binlog retention value, the ClickPipe will enter an errored state and a resync is required.
By default, Amazon RDS purges the binary log as soon as possible (i.e., *lazy purging*). We recommend increasing the binlog retention interval to at least **72 hours** to ensure availability of binary log files for replication under failure scenarios. To set an interval for binary log retention ([`binlog retention hours`](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-stored-proc-configuring.html#mysql_rds_set_configuration-usage-notes.binlog-retention-hours)), use the [`mysql.rds_set_configuration`](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-stored-proc-configuring.html#mysql_rds_set_configuration) procedure:
[//]: # "NOTE Most CDC providers recommend the maximum retention period for RDS (7 days/168 hours). Since this has an impact on disk usage, we conservatively recommend a minimum of 3 days/72 hours."
```text theme={null}
mysql=> call mysql.rds_set_configuration('binlog retention hours', 72);
```
If this configuration isn't set or is set to a low interval, it can lead to gaps in the binary logs, compromising ClickPipes' ability to resume replication.
Configure binlog settings
The parameter group can be found when you click on your MySQL instance in the RDS Console, and then navigate to the **Configuration** tab.
If you have a MySQL cluster, the parameters below can be found in the [DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.CreatingCluster.html) parameter group instead of the DB instance group.
Click the parameter group link, which will take you to its dedicated page. You should see an **Edit** button in the top right.
The following parameters need to be set as follows:
1. `binlog_format` to `ROW`.
2. `binlog_row_metadata` to `FULL`
3. `binlog_row_image` to `FULL`
Then, click on **Save Changes** in the top right corner. You may need to reboot your instance for the changes to take effect — a way of knowing this is if you see `Pending reboot` next to the parameter group link in the **Configuration** tab of the RDS instance.
Enable GTID Mode
The MySQL ClickPipe also supports replication without GTID mode. However, enabling GTID mode is recommended for better performance and easier troubleshooting.
[Global Transaction Identifiers (GTIDs)](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids.html) are unique IDs assigned to each committed transaction in MySQL. They simplify binlog replication and make troubleshooting more straightforward. We **recommend** enabling GTID mode, so that the MySQL ClickPipe can use GTID-based replication.
GTID-based replication is supported for Amazon RDS for MySQL versions 5.7, 8.0 and 8.4. To enable GTID mode for your Aurora MySQL instance, follow these steps:
1. In the RDS Console, click on your MySQL instance.
2. Click on the **Configuration** tab.
3. Click on the parameter group link.
4. Click on the **Edit** button in the top right corner.
5. Set `enforce_gtid_consistency` to `ON`.
6. Set `gtid-mode` to `ON`.
7. Click on **Save Changes** in the top right corner.
8. Reboot your instance for the changes to take effect.
The MySQL ClickPipe also supports replication without GTID mode. However, enabling GTID mode is recommended for better performance and easier troubleshooting.
Connect to your RDS MySQL instance as an admin user and execute the following commands:
1. Create a dedicated user for ClickPipes:
```sql theme={null}
CREATE USER 'clickpipes_user'@'host' IDENTIFIED BY 'some-password';
```
2. Grant schema permissions. The following example shows permissions for the `mysql` database. Repeat these commands for each database and host you want to replicate:
```sql theme={null}
GRANT SELECT ON `mysql`.* TO 'clickpipes_user'@'host';
```
3. Grant replication permissions to the user:
```sql theme={null}
GRANT REPLICATION CLIENT ON *.* TO 'clickpipes_user'@'%';
GRANT REPLICATION SLAVE ON *.* TO 'clickpipes_user'@'%';
```
IP-based access control
To restrict traffic to your Aurora MySQL instance, add the [documented static NAT IPs](/integrations/clickpipes/home#list-of-static-ips) to the **Inbound rules** of your RDS security group.
Private access via AWS PrivateLink
To connect to your RDS instance through a private network, you can use AWS PrivateLink. Follow the [AWS PrivateLink setup guide for ClickPipes](/resources/support-center/knowledge-base/cloud-services/aws-privatelink-setup-for-clickpipes) to set up the connection.
Next steps
Now that your Amazon RDS MySQL instance is configured for binlog replication and securely connecting to ClickHouse Cloud, you can [create your first MySQL ClickPipe](/integrations/clickpipes/mysql#create-your-clickpipe). For common questions around MySQL CDC, see the [MySQL FAQs page](/integrations/clickpipes/mysql/faq).