You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/data-ingestion/clickpipes/mysql/source/aurora.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,15 @@ This step-by-step guide shows you how to configure Amazon Aurora MySQL to replic
25
25
26
26
The binary log is a set of log files that contain information about data modifications made to a MySQL server instance, and binary log files are required for replication. To configure binary log retention in Aurora MySQL, you must [enable binary logging](#enable-binlog-logging) and [increase the binlog retention interval](#binlog-retention-interval).
27
27
28
-
### 1. Enable binary logging via automated backup {#enable-binlog-logging-aurora}
28
+
### 1. Enable binary logging via automated backup {#enable-binlog-logging}
29
29
30
-
The automated backups feature determines whether binary logging is turned on or off for MySQL. It can be set in the AWS console:
30
+
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).
31
31
32
32
<Imageimg={rds_backups}alt="Enabling automated backups in Aurora"size="lg"border/>
33
33
34
-
We recommend setting backup retention to a reasonably long value, depending on the replication use case.
34
+
We recommend setting the **Backup retention period** to a reasonably long value, depending on the replication use case.
35
35
36
-
### 2. Increase the binlog retention interval {#binlog-retention-interval-aurora}
36
+
### 2. Increase the binlog retention interval {#binlog-retention-interval}
37
37
38
38
:::warning
39
39
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.
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.
51
51
52
-
## Configure binlog settings in the parameter group {#binlog-parameter-group}
52
+
## Configure binlog settings {#binlog-settings}
53
53
54
-
The parameter group can be found when you click on your MySQL instance in the RDS Console, and then heading over to the `Configurations` tab.
54
+
The parameter group can be found when you click on your MySQL instance in the RDS Console, and then navigate to the **Configuration** tab.
55
55
56
56
:::tip
57
-
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.
57
+
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.
58
58
:::
59
59
60
60
<Imageimg={aurora_config}alt="Where to find parameter group in Aurora"size="lg"border/>
61
61
62
62
<br/>
63
-
Click the parameter group link, which will take you to its dedicated page. You should see an `Edit` button in the top right.
63
+
Click the parameter group link, which will take you to its dedicated page. You should see an **Edit** button in the top right.
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 `Configurations` tab of the Aurora instance.
83
+
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 Aurora instance.
84
84
85
85
## Enable GTID mode (recommended) {#gtid-mode}
86
86
@@ -93,12 +93,12 @@ The MySQL ClickPipe also supports replication without GTID mode. However, enabli
93
93
GTID-based replication is supported for Amazon Aurora MySQL v2 (MySQL 5.7) and v3 (MySQL 8.0), as well as Aurora Serverless v2. To enable GTID mode for your Aurora MySQL instance, follow these steps:
94
94
95
95
1. In the RDS Console, click on your MySQL instance.
96
-
2. Click on the `Configurations` tab.
96
+
2. Click on the **Configuration** tab.
97
97
3. Click on the parameter group link.
98
-
4. Click on the `Edit` button in the top right corner.
98
+
4. Click on the **Edit** button in the top right corner.
99
99
5. Set `enforce_gtid_consistency` to `ON`.
100
100
6. Set `gtid-mode` to `ON`.
101
-
7. Click on `Save Changes` in the top right corner.
101
+
7. Click on **Save Changes** in the top right corner.
102
102
8. Reboot your instance for the changes to take effect.
@@ -130,7 +130,7 @@ Connect to your Aurora MySQL instance as an admin user and execute the following
130
130
131
131
### IP-based access control {#ip-based-access-control}
132
132
133
-
To restrict traffic to your Aurora MySQL instance, add the [documented static NAT IPs](../../index.md#list-of-static-ips) to the `Inbound rules` of your Aurora security group.
133
+
To restrict traffic to your Aurora MySQL instance, add the [documented static NAT IPs](../../index.md#list-of-static-ips) to the **Inbound rules** of your Aurora security group.
134
134
135
135
<Image img={security_group_in_rds_mysql} alt="Where to find security group in Aurora MySQL?" size="lg" border/>
Copy file name to clipboardExpand all lines: docs/integrations/data-ingestion/clickpipes/mysql/source/rds.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,15 @@ This step-by-step guide shows you how to configure Amazon RDS MySQL to replicate
25
25
26
26
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).
27
27
28
-
### 1. Enable binary logging via automated backup{#enable-binlog-logging}
28
+
### 1. Enable binary logging via automated backup{#enable-binlog-logging}
29
29
30
-
The automated backups feature determines whether binary logging is turned on or off for MySQL. It can be set in the AWS console:
30
+
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).
31
31
32
32
<Imageimg={rds_backups}alt="Enabling automated backups in RDS"size="lg"border/>
33
33
34
-
We recommend setting backup retention to a reasonably long value, depending on the replication use case.
34
+
We recommend setting the **Backup retention period** to a reasonably long value, depending on the replication use case.
35
35
36
-
### 2. Increase the binlog retention interval{#binlog-retention-interval}
36
+
### 2. Increase the binlog retention interval{#binlog-retention-interval}
37
37
38
38
:::warning
39
39
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.
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.
51
51
52
-
## Configure binlog settings in the parameter group {#binlog-parameter-group}
52
+
## Configure binlog settings {#binlog-settings}
53
53
54
-
The parameter group can be found when you click on your MySQL instance in the RDS Console, and then heading over to the `Configurations` tab.
54
+
The parameter group can be found when you click on your MySQL instance in the RDS Console, and then navigate to the **Configuration** tab.
55
55
56
56
:::tip
57
-
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.
57
+
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.
58
58
:::
59
59
60
60
<Imageimg={rds_config}alt="Where to find parameter group in RDS"size="lg"border/>
61
61
62
62
<br/>
63
-
Click the parameter group link, which will take you to its dedicated page. You should see an `Edit` button in the top right.
63
+
Click the parameter group link, which will take you to its dedicated page. You should see an **Edit** button in the top right.
@@ -79,7 +79,7 @@ The following parameters need to be set as follows:
79
79
<Imageimg={binlog_row_image}alt="Binlog row image to FULL"size="lg"border/>
80
80
81
81
<br/>
82
-
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 `Configurations` tab of the RDS instance.
82
+
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.
83
83
84
84
## Enable GTID Mode {#gtid-mode}
85
85
@@ -92,12 +92,12 @@ The MySQL ClickPipe also supports replication without GTID mode. However, enabli
92
92
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:
93
93
94
94
1. In the RDS Console, click on your MySQL instance.
95
-
2. Click on the `Configurations` tab.
95
+
2. Click on the **Configuration** tab.
96
96
3. Click on the parameter group link.
97
-
4. Click on the `Edit` button in the top right corner.
97
+
4. Click on the **Edit** button in the top right corner.
98
98
5. Set `enforce_gtid_consistency` to `ON`.
99
99
6. Set `gtid-mode` to `ON`.
100
-
7. Click on `Save Changes` in the top right corner.
100
+
7. Click on **Save Changes** in the top right corner.
101
101
8. Reboot your instance for the changes to take effect.
@@ -129,7 +129,7 @@ Connect to your RDS MySQL instance as an admin user and execute the following co
129
129
130
130
### IP-based access control {#ip-based-access-control}
131
131
132
-
To restrict traffic to your Aurora MySQL instance, add the [documented static NAT IPs](../../index.md#list-of-static-ips) to the `Inbound rules` of your RDS security group.
132
+
To restrict traffic to your Aurora MySQL instance, add the [documented static NAT IPs](../../index.md#list-of-static-ips) to the **Inbound rules** of your RDS security group.
133
133
134
134
<Image img={security_group_in_rds_mysql} alt="Where to find security group in RDS MySQL?" size="lg" border/>
0 commit comments