# Amazon MySQL RDS (v1)

Information note **Amazon MySQL RDS extraction is supported by Stitch**   
This integration is powered by [Singer's](https://www.singer.io/) Amazon MySQL RDS tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-mysql).  
  
For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport).

## Amazon MySQL RDS feature snapshot

A high-level look at Stitch's Amazon MySQL RDS (v1) integration, including release status, useful links, and the features supported in Stitch.

| **STITCH** |  |  |  |
| --- | --- | --- | --- |
| **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Deprecated on November 8, 2021 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **Supported versions**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | n/a |
| **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Remove icon<br><br>This version of the integration isn't available via the API.<br><br><br>Not available | **Singer GitHub repository** | [singer-io/tap-mysql](https://github.com/singer-io/tap-mysql) |
| **CONNECTION METHODS** |  |  |  |
| **SSH connections**<br><br>the Info icon<br><br>Indicates if SSH tunnels are supported for connecting this database to Stitch. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **SSL connections**<br><br>the Info icon<br><br>Indicates if SSL connections are supported for connecting this database to Stitch. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **REPLICATION METHODS** |  |  |  |
| **[Log-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/log-based-incremental)**<br><br>the Info icon<br><br>Log-based Incremental Replication is a replication method in which Stitch identifies modifications to records - including inserts, updates, and deletes - using a database's binary log files. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Key-based Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental)**<br><br>the Info icon<br><br>Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[Full Table Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/full-table)**<br><br>the Info icon<br><br>Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |  |  |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **[View replication](https://help.qlik.com/en-US/stitch/replication/replicating-database-views)**<br><br>the Info icon<br><br>Indicates if Stitch supports replicating views from this database integration. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Warning 2 icon<br><br>Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.<br><br><br>Supported, with prerequisites |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |

## Connecting Amazon MySQL RDS

### Amazon MySQL RDS setup requirements

To set up Amazon MySQL RDS in Stitch, you need:

* **Privileges in Amazon Web Services (AWS) that allow you to**:

  * Create/manage Security Groups, which is required to whitelist Stitch’s IP addresses.
  * View database details, which is required for retrieving the database’s connection details.

* **The `CREATE USER` or `INSERT` privilege (for the `mysql` database).** The [`CREATE USER` privilege](https://dev.mysql.com/doc/refman/8.0/en/create-user.html) is required to create a database user for Stitch.

* **The `GRANT OPTION` privilege in Amazon MySQL RDS.** The [`GRANT OPTION` privilege](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html#priv_grant-option) is required to grant the necessary privileges to the Stitch database user.

### Step 1: Verify your Stitch account's data pipeline region

First, you’ll log into Stitch and verify the data pipeline region your account is using. Later in this guide, you’ll need to grant Stitch access by whitelisting our IP addresses.

The IP addresses you’ll whitelist depend on the [**Data pipeline region** your account is in](https://help.qlik.com/en-US/stitch/security/supported-data-pipeline-regions).

1. [Sign into your Stitch account](https://app.stitchdata.com/), if you haven’t already.

2. Click **User menu (your icon) &gt; Edit User Settings** and locate the **Data pipeline region** section to verify your account’s region.

3. Locate the list of IP addresses for your region:

   * [North America region IP addresses](https://help.qlik.com/en-US/stitch/security/stitch-ip-addresses#north-america-ip-addresses)

   * [Europe region IP addresses](https://help.qlik.com/en-US/stitch/security/stitch-ip-addresses#europe-ip-addresses)

Keep this list handy - you’ll need it later.

### Step 2: Configure database connection settings

In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:

* **A direct connection** will work if your database is publicly accessible.
* **An SSH tunnel** is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.

Click the option you’re using below and follow the instructions.

I'm using an SSH tunnel to connect.

1. Follow the steps in the [Setting up an SSH Tunnel for a database in Amazon Web Services guide](https://help.qlik.com/en-US/stitch/security/data-encryption/setting-up-ssh-tunnel-for-amazon-web-services) to set up an SSH tunnel for Amazon MySQL RDS.
2. Complete the steps in this guide after the SSH setup is complete.

#### I'm using a direct connection.

Information note **Note**: This step requires privileges in AWS that allow you to create and manage Security Groups.

For Stitch to successfully connect with your database instance, you’ll need to add our IP addresses to the appropriate Security Group via the AWS management console.

Security Groups must reside in the same VPC as the instance. Use the instructions below to create a security group for Stitch and grant access to the VPC.

1. Log into your AWS account.

2. Navigate to the Security Group Management page, typically **Services &gt; Compute &gt; EC2**.

3. Click the **Security Groups** option, under **Network & Security** in the menu on the left side of the page.

4. Click **Create Security Group**.

5. In the window that displays, fill in the fields as follows:

   * **Security group name**: Enter a unique name for the Security Group. For example: `Stitch`
   * **Description**: Enter a description for the security group.
   * **VPC**: Select the VPC that contains the database you want to connect to Stitch. **Note**: The Security Group and database must be in the same VPC, or the connection will fail.

6. In the **Inbound** tab, click **Add Rule**.

7. Fill in the fields as follows:

   * **Type**: Select `Custom TCP Rule`
   * **Port Range**: Enter the port your database uses. (`3306` by default)
   * **CIDR, IP or Security Group**: Paste one of the Stitch IP addresses **for your Stitch data pipeline region** that you retrieved in [Step 1](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#verify-stitch-account-region).

8. Click **Add Rule** to add an additional Inbound rule.

9. Repeat steps 6-8 until all the IP addresses for your Stitch data pipeline region have been added.

   This is what a Security Group using Stitch’s North America IP addresses looks like:

   ![Whitelisting Stitch North America IP addresses through Inbound Security Group rules](https://help.qlik.com/en-US/stitch/images/shared/whitelisting-ips/amazon-security-group.png)Whitelisting Stitch North America IP addresses through Inbound Security Group rulesWhitelisting Stitch North America IP addresses through Inbound Security Group rules

10. When finished, click **Create** to create the Security Group.

### Step 3: Configure Log-based Incremental Replication

Information note **Note**: Skip this step if you’re not planning to use Log-based Incremental Replication. [Click to skip ahead](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#create-a-database-user).

Information note

**Important:** **Requirements for configuring binlog replication**

**To use binlog replication, your Amazon MySQL RDS database must be running MySQL version 5.6.2 or greater**.

Additionally, setting up binlog replication requires rebooting your database to ensure parameter changes take effect. To minimize disruptions, we recommend performing the reboot during non-peak usage hours.

While Log-based Incremental Replication is the most accurate and efficient method of replication, using this replication method may, at times, require manual intervention or impact the source database’s performance. Refer to the [Log-based Incremental Replication documentation](https://help.qlik.com/en-US/stitch/replication/replication-methods/log-based-incremental) for more info.

You can also use one of Stitch’s other [Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods), which don’t require any database configuration. Replication Methods can be changed at any time.

* [Step 3.1: Configure the database parameter group](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#configure-database-parameter-group)

* [Step 3.2: Define the backup retention period](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-backup-retention-period)

* [Step 3.3: Apply parameter changes and reboot the database](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#apply-changes-reboot-database)

* [Step 3.4: Retrieve server IDs](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#server-id)

* [Step 3.5: Define the binlog retention setting](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-binlog-retention-setting)

#### Step 3.1: Configure the database parameter group

In this step, you’ll configure the database parameters required to use Log-based Incremental Replication.

* Instructions
* Server settings list

1. From the RDS Dashboard, click **Databases** on the left side of the page.

2. Click the Amazon MySQL RDS instance you want to connect to Stitch. This will open the database’s details page.

3. Scroll down to the **Details** section.

4. In the **Configurations** column, locate the **Parameter group** field.

5. Click the parameter group. This will open the settings page for the parameter group.

6. Click the **Edit parameters** button.

7. Locate the parameters in the list below, and enter the required values into the **Values** column:

   * **binlog\_format**: `ROW`

   * **binlog\_row\_image**: `FULL`

   * **log\_slave\_updates**: `1`

   **Note**: `log_slave_updates` is applicable only if you are connecting a read replica to Stitch. If you aren’t connecting a read replica, you don’t have to define this parameter.

   ![RDS MySQL parameter group page with binlog_format and binlog_row_image parameters highlighted](https://help.qlik.com/en-US/stitch/images/integrations/rds-mysql-parameter-group-editing.png)RDS MySQL parameter group page with binlog\_format and binlog\_row\_image parameters highlightedRDS MySQL parameter group page with binlog\_format and binlog\_row\_image parameters highlighted

8. When finished, click the **Save changes** button.

In the table below are the names, required values, and descriptions of the server settings you must define.

| **Setting** | **Value** | **Description** |
| --- | --- | --- |
| [binlog_format](https://dev.mysql.com/doc/refman/5.6/en/replication-options-binary-log.html#sysvar_binlog_format) | `ROW` | **Note**: This setting is available on Amazon MySQL RDS databases running version 5.6.2 or greater.<br><br>Defines the binary logging format. A `ROW` value enables “event-based” capture, which describes what happens to records in the database. **This is necessary to use binlog.**<br><br>Stitch supports the following event types:<br><br><ul> <li><code>INSERT</code></li> <li><code>UPDATE</code></li> <li><code>DELETE</code></li></ul> |
| [binlog_row_image](https://dev.mysql.com/doc/refman/5.6/en/replication-options-binary-log.html#sysvar_binlog_row_image) | `FULL` | **Note**: This setting is available on Amazon MySQL RDS databases running version 5.6.2 or greater.<br><br>Defines how row images are written to the binary log. A `FULL` value ensures that all columns in a row are logged in the before and after images of a change, enabling Stitch to accurately capture all changes made to a record. |
| [log_slave_updates](https://dev.mysql.com/doc/refman/5.6/en/replication-options-binary-log.html#sysvar_log_slave_updates) | `1` | Indicates whether updates received by a read replica from a master server should be logged to the replica’s own binary log.<br><br>**Note**: This is applicable when using a read replica. |

#### Step 3.2: Define the backup retention period

Information note **Enabling automatic backups is required to use Log-based Incremental Replication.** In Amazon RDS, enabling automatic backups also enables binary logging, which is what Stitch uses to perform Log-based Incremental Replication. Skipping this step or disabling automatic backups will cause replication issues in Stitch. Refer to the **Transaction Size** section of [Amazon’s Importing Data into a MySQL DB Instance](https://docs.aws.amazon.com/en_us/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.Other.html) documentation for more info.

The backup retention period setting defines the number of days for which automated backups are retained. This ensures that data can still be replicated even if a job is interrupted, there’s database or Stitch downtime, etc.

1. Navigate back to the **Databases** page by using the menu on the left side of the page.

2. Select the instance you’re connecting to Stitch.

3. Click the **Modify** button.

4. On the **Modify DB Instance** page, scroll down to the **Backup** section.

5. Set **Backup retention period** to anything greater than `1 day`:

   ![A backup retention period setting of 1 day for an RDS instance in the AWS console](https://help.qlik.com/en-US/stitch/images/integrations/rds-binlog-backup-retention-period.png)A backup retention period setting of 1 day for an RDS instance in the AWS consoleA backup retention period setting of 1 day for an RDS instance in the AWS console

#### Step 3.3: Apply parameter changes and reboot the database

1. Scroll to the bottom of the **Databases** page and click **Continue**.

2. The next page will display a summary of the modifications made to the database. In the **Scheduling of Modifications** section, select the **Apply Immediately** option.

3. Click **Modify DB Instance** to apply the changes.

4. Navigate to the Instance Details page and locate the **Parameter group**. Initially, the Parameter group should say `applying`.

   When it changes to `pending-reboot`, you can reboot the database and apply the changes.

5. Scroll up to the top of the page and locate the **Instance actions** menu.

6. In this menu, click **Reboot**.

7. On the next page, click **Reboot** to confirm you want to reboot the instance.

Rebooting the instance will take a few minutes. When the status of the **parameter group** changes to `in-sync` and the **DB instance status** (located at the top of the Instance Details page) changes to `available`, the reboot will be complete:

![An "Available" DB instance status for an RDS instance in the AWS console](https://help.qlik.com/en-US/stitch/images/integrations/rds-binlog-db-instance-status.png)An "Available" DB instance status for an RDS instance in the AWS consoleAn "Available" DB instance status for an RDS instance in the AWS console

#### Step 3.4: Retrieve server IDs

Information note

**Required for Log-based Replication**

This step is required if using Log-based Replication and any of the following are true:

1. You’re connecting a read replica to Stitch
2. You’re connecting multiple databases to Stitch, all of which are on the same Amazon MySQL RDS server. These can be read replicas, or databases on the master instance.
3. You’re adding a new Amazon MySQL RDS Stitch integration, and the database is on the same server as other previously-connected databases.

When Stitch connects to your database and uses Log-based Replication, a unique server ID will be required. This ID ensures that the integration - or integrations, if you’re connecting multiple databases - will not encounter conflicts during the replication process.

To avoid conflicts, you’ll check which server IDs are currently in use and then define a new, unqiue ID in Stitch.

1. Log into the MySQL server that acts as the replication master.

2. Run the following statement:

   ```
   mysql> SHOW SLAVE HOSTS;
   ```

3. The `SHOW SLAVE HOSTS` statement will return information about servers that are or have been connected as replication slaves:

   ```
   +------------+-------------+------+-----------+------------+
   | Server_id  | Host        | Port | Master_id | Slave_UUID |
   +------------+-------------+------+-----------+------------+
   | 192168010  | stitch_prod | 3306 | 192168011 | <UUID>     |
   | 1921680101 | stitch_dev  | 3306 | 192168011 | <UUID>     |
   +------------+-------------+------+-----------+------------+
   ```

When you complete the setup in Stitch, you’ll define a unique server ID for your Stitch Amazon MySQL RDS integration to use.

#### Step 3.5: Define the binlog retention setting

In addition to the [backup retention period](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-backup-retention-period), you also need to define the `binlog retention hours` setting. This parameter specifies the number of hours to the database server should retain binary logs.

To specify the number of hours, use the [`mysql.rds_set_configuration` procedure](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql_rds_set_configuration.html) when logged into the Amazon MySQL RDS master instance.

In this example, the logs will be retained for seven days (`24 x 7 = 168`):

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

Stitch recommends a minimum of three days for the retention period, but strongly recommend seven. **Note**: The maximum `binlog retention hours` value for Amazon MySQL RDS databases is 168 hours (seven days).

### Step 4: Create a Stitch database user

Information note **Note**: You must have the `CREATE USER` and `GRANT OPTION` privileges to complete this step.

Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.

* Instructions
* Privileges list

1. Log into your database as a user with `CREATE USER` and `GRANT OPTION` privileges.

2. Run the following command to create the Stitch database user:

   ```
   CREATE USER '<stitch_username>'@'localhost' IDENTIFIED BY '<password>';
   ```

   Replace `<password>` with a secure password. If using SSH, this can be different than the SSH password.

3. Grant the Stitch user `SELECT` privileges by running this command for every table you want to replicate:

   ```
   GRANT SELECT ON '<database_name>'.'<table_name>' to '<stitch_username>'@'localhost';
   ```

   Limiting access to only the tables you want to replicate ensures that the integration can complete discovery (a structure sync) in a timely manner. If you encounter issues in Stitch where tables aren’t displaying, try limiting the Stitch database user’s table access.

   **Note:** Column-level permissions are not supported for use with Log-based Incremental Replication. Restricting access to columns will cause replication issues.

Information note

**Important:** **Using Log-based Incremental Replication**

Additionally, if you want to use Log-based Incremental Replication, you’ll also need to grant the Stitch user replication privileges:

```
GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO '<stitch_username>'@'localhost';
```

See the **Privileges list** tab for an explanation of why these permissions are required by Stitch.

In the table below are the database user privileges Stitch requires to connect to and replicate data from a Amazon MySQL RDS database.

| **Privilege name** | **Reason for requirement** |
| --- | --- |
| [SELECT](https://dev.mysql.com/doc/refman/5.5/en/privileges-provided.html#priv_select) | Required to select rows from tables in a database. |
| [REPLICATION CLIENT](https://dev.mysql.com/doc/refman/5.5/en/privileges-provided.html#priv_replication-client) | **Required for binlog replication.** Required to use [`SHOW BINARY LOGS`](https://dev.mysql.com/doc/refman/5.5/en/show-binary-logs.html), which determines that a binary log exists. |
| [REPLICATION SLAVE](https://dev.mysql.com/doc/refman/5.5/en/privileges-provided.html#priv_replication-slave) | **Required for binlog replication.** Required to use [`SHOW MASTER STATUS`](https://dev.mysql.com/doc/refman/5.5/en/show-binary-logs.html), which fetches the current binlog file and position on the server. |

### Step 5: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

* [Step 5.1: Locate the database connection details in AWS](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#locating-rds-database-details)

* [Step 5.2: Define the database connection details in Stitch](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-connection-details)

* [Step 5.3: Define the SSH connection details](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#ssh-connection-details)

* [Step 5.4: Define the SSL connection details](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#ssl-connection-details)

* [Step 5.5: Define the Log-based Replication setting](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-log-based-replication-setting)

* [Step 5.6: Create a replication schedule](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#create-replication-schedule)

* [Step 5.7: Save the integration](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#save-integration)

#### Step 5.1: Locate the database connection details in AWS

1. Sign into the [AWS Console](https://console.aws.amazon.com/), if needed.

2. Navigate to the **RDS** option.

3. On the **RDS Dashboard** page, click the **Databases** option on the left side of the page. This will open the **RDS Databases** page.

4. In the list of databases, locate and click on the instance you want to connect to Stitch. This will open the **Database Details** page.

5. On the Database Details page, scroll down to the **Connectivity & security** section.

6. Locate the following fields:

   * **Endpoint**

   * **DB Name:** This field contains the name of the database used to launch the instance. You’ll only need this info if you want to connect this specific database to Stitch.

     You can connect this database to Stitch, or another database within Amazon MySQL RDS.

   * **Port:** This is the port used by the database.

Leave this page open for now - you’ll need it to complete the setup.

#### Step 5.2: Define the database connection details in Stitch

1. If you aren’t signed into your Stitch account, [sign in now](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Locate and click the **MySQL** icon.

4. Fill in the fields as follows:

   * **Integration Name**: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

     For example, the name “Stitch Amazon MySQL RDS” would create a schema called `stitch_amazon_mysql_rds` in the destination. **Note:** The schema name cannot be changed after the integration is saved.

   * **Integration Name**: Paste the **Endpoint** address from the Amazon MySQL RDS Details page in AWS into this field. Don’t include the port number, if it’s appended to the end of the endpoint string - this will cause errors.

   * **Port**: Enter the port used by the Amazon MySQL RDS instance. The default is `3306`.

   * **Username**: Enter the Stitch Amazon MySQL RDS database user’s username.

   * **Password**: Enter the password for the Stitch Amazon MySQL RDS database user.

#### Step 5.3: Define the SSH connection details

Information note **Note**: Skip this step if you’re not using SSH to connect to Stitch.

If you’re using an SSH tunnel to connect your Amazon MySQL RDS database to Stitch, you’ll also need to define the SSH settings. Refer to the [Setting up an SSH Tunnel for a database in Amazon Web Services guide](https://help.qlik.com/en-US/stitch/security/data-encryption/setting-up-ssh-tunnel-for-amazon-web-services) for assistance with completing these fields.

1. Click the **SSH Tunnel** checkbox.

2. Fill in the fields as follows:

   * **SSH Host**: Paste the **Public DNS** of the SSH sever (EC2 instance) into this field. Refer to the [Amazon SSH guide](https://help.qlik.com/en-US/stitch/security/data-encryption/setting-up-ssh-tunnel-for-amazon-web-services#retrieve-ssh-connection-details) for instructions on retrieving this info.

   * **SSH Port**: Enter the SSH port of the SSH server (EC2 instance) into this field. This will usually be `22`.

   * **SSH User**: Enter the Stitch Linux (SSH) user’s username.

#### Step 5.4: Define the SSL connection details

Information note **Note**: Skip this step if you’re not using SSL to connect to Stitch.

1. Check the **Connect using SSL** checkbox. **Note:** The database must support and allow SSL connections for this setting to work correctly.

2. Fill in the fields as follows:

   * **SSL Certificate**: The certificate (typically a CA or server certificate) Stitch should verify the SSL connection against. The connection will succeed only if the server’s certifcate verifies against the certificate provided.

     **Note**: Providing a certifcate via this property isn’t required to use SSL. This is only if Stitch should verify the connection against a specific certificate.

   * **Use an SSL client key**: If SSL client authentication should be used, check this box. This will display the **Client Certificate** and **Client Key** fields, which are both required when using client authentication.

   * **Client Certificate**: If using SSL client authentication, paste the client certificate Stitch should use into this field. **Note**: You must also provide a **Client Key** for the connection to be successful.

   * **Client Key**: If using SSL client authentication, paste the client key Stitch should use into this field. **Note**: You must also provide a **Client Certificate** for the connection to be successful.

#### Step 5.5: Define the Log-based Replication setting

Information note **Note**: Skip this step if you’re not planning to use Log-based Incremental Replication. [Click to skip ahead](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#create-replication-schedule).

In the **Log-based Replication** section, you can set this as the integration’s default Replication Method.

When enabled, tables that are set to replicate will use [Log-based Incremental Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/log-based-incremental) by default. If you don’t want a table to use Log-based Incremental Replication, you can change it in the Table Settings page for that table.

If this setting isn’t enabled, you’ll have to select a [Replication Method](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#sync-data) for each table you set to replicate.

#### Step 5.6: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Amazon MySQL RDS integrations support the following replication scheduling methods:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)

* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.

#### Step 5.7: Save the integration

When finished, click **Check and Save**.

Stitch will perform a connection test to the Amazon MySQL RDS database; if successful, a *Success!* message will display at the top of the screen. **Note**: This test may take a few minutes to complete.

### Step 6: Select data to replicate

Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).

The last step is to select the tables and columns you want to replicate. [](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#schema)

**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.

* Selection options
* Individual tables and columns
* All tables and columns
* Database views

For Amazon MySQL RDS integrations, you can select:

1. **Individual tables and columns**

2. **All tables and columns** (except views)

3. **Database views**

Click the tabs to view instructions for each selection method.

1. In the Integration Details page, click the **Tables to Replicate** tab.

2. Locate a table you want to replicate.

3. Click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.

4. After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.

5. Next, you’ll define the table’s Replication Method. Click the **Table Settings** button.

6. In the **Table Settings** page:

   1. Define the table’s **Replication Method**, or skip this step if you want to use the [integration’s default method](https://help.qlik.com/en-US/stitch/integrations/databases/amazon-rds-mysql#define-log-based-replication-setting).

   2. If using [Key-based Incremental Replication](https://help.qlik.com/en-US/stitch/replication/replication-methods/key-based-incremental), select a [Replication Key](https://help.qlik.com/en-US/stitch/replication/replication-keys).

   3. When finished, click **Update Settings**.

7. Repeat this process for every table you want to replicate.

8. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.

Information note

**Important:** Before using this feature, note that:

1. Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections.

2. Log-based Incremental Replication must be enabled and set as the default Replication Method to use the Select All feature.

Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.

1. Click into the integration from the Stitch Dashboard page.

2. Click the **Tables to Replicate** tab.

3. Navigate to the table level, selecting any databases and/or schemas that contain tables you want to replicate.

4. In the list of tables, click the box next to the **Table Names** column.

5. In the menu that displays, click **Track AllTables and Fields (Except Views)**:

   ![The Track AllTables and Fields (Except Views) menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track AllTables and Fields (Except Views) menu in the Tables to Replicate tabThe Track AllTables and Fields (Except Views) menu in the Tables to Replicate tab

6. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections.

Setting a database view to replicate is similar to selecting a table, with a few differences. Refer to the [Replicating Database Views guide](https://help.qlik.com/en-US/stitch/replication/replicating-database-views) for detailed instructions.

At a high level, you’ll need to complete the following to select a database view:

1. [Verify the database user’s permissions](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--verify-database-user-permissions)
2. [Select the view](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--select-view-in-stitch)
3. **Optional**: [Define the view’s Primary Key](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--define-view-primary-key)
4. [Define the view’s Replication Method](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--define-view-replication-method)
5. [Save the view’s settings](https://help.qlik.com/en-US/stitch/replication/replicating-database-views#step--save-view-settings)

### Initial and historical replication jobs

After you finish setting up Amazon MySQL RDS, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.**

Information note

**Initial replication jobs with Anchor Scheduling**

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information.

#### Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.