Amazon Aurora MySQL

Amazon Aurora is a drop-in replacement for MySQL that combines the performance and availability of traditional enterprise databases with the simplicity and cost-effectiveness of open source databases. Amazon Aurora is fully managed by Amazon Relational Database Service (RDS), which automates time-consuming administration tasks like hardware provisioning, database setup, patching, and backups.

You can ingest data from your Amazon Aurora MySQL database using Hevo Pipelines and replicate it to a Destination of your choice.

Prerequisites


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

Create a Read Replica (Optional)

To use an existing read-replica or connect Hevo to your master database, skip to Set up MySQL Binary Logs for Replication section.

An Aurora database cluster with single-master replication has one primary database instance and up to 15 Aurora Replicas. To create a read-replica:

  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 Aurora MySQL instance you want to replicate. For example, database-1, in the image below.

    Note : The Role column denotes whether your Aurora MySQL is a Provisioned one Serverless. If you’re using a Serverless DB cluster, you can skip creating a replica.

    Select DB Identifier

  4. In the Actions drop-down, click Add reader.

    Add reader

  5. In the Settings panel, specify the following:

    • DB instance identifier: The replica instance you are creating.

    • Aurora replica source: The master or primary database instance being replicated.

    Select replica source

  6. Under Connectivity, Public access, select Publicly accessible to allow connection to the database instance via a public IP address, such as Hevo’s IP address.

    Select publicly accessible

  7. Scroll down and click Create Replica.

You can now see the Read Replica instance in the Databases page. Use this replica for any further steps and processes.

View read replica


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.

Hevo supports data ingestion for replication from MySQL servers via binary logs (BinLog). For this, binary logging must be enabled on your MySQL instance.

To enable binary logging for an Aurora DB cluster, follow these steps:

  1. Open the Amazon RDS console.

  2. In the left navigation pane, select Parameter groups.

    Select parameter groups

  3. Select the instance with Type as DB cluster parameter group.

    Note: If you are using the default Aurora DB cluster parameter group, then create a new DB cluster parameter group. Type, choose DB cluster parameter group.

  4. Click Edit Parameters.

    Edit parameters

  5. Search for the parameter Name binlog_format, and activate binary log replication by setting the Values to ROW.

  6. Click Save changes.

    Specify binlog format

This confirms that binary logging is now enabled for your Aurora MySQL instance.

Read BinLog Replication and BinLog Alerts.

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


Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP address for your region to enable Hevo to connect to your Amazon Aurora MySQL database. To do this:

  1. Open the Amazon RDS console.

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

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

  4. In the Connectivity & security tab, click the link text under Security, VPC security groups.

  5. In the Actions drop-down on the top right, select Edit inbound rules.

  6. In the Edit inbound rules page:

    1. Click Add rule.

    2. Add a new rule either with 0.0.0.0/0 or Hevo’s IP address for your region to give access to the Amazon Aurora MySQL instance.

    3. Click Save rules.

      Add rule to whitelist Hevo


Create a Database User and Grant Privileges

Perform the following steps to grant SELECT and REPLICATION privileges to the database user:

  1. Log into your Amazon Aurora MySQL database instance as a root user.

  2. Run the following command to create a new database user. For example, we are using hevo as user name:

    CREATE USER hevo@'%' IDENTIFIED BY '<password>';
    
  3. Run the following command to grant SELECT and REPLICATION privileges to the new database user:

    GRANT SELECT, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO hevo;
    
    

    Note: The REPLICATION SLAVE privilege is required only if you are connecting a read replica. When it is granted to the authenticating user, updates received by a replica server from a source server are logged to the replica’s own binary log.

  4. Grant privileges to the database user to read BinLog settings, if Pipeline mode is Binlog:

    GRANT SELECT ON mysql.rds_configuration to hevo;
    

Retrieve the Hostname and Port Number (Optional)

Note: The Amazon Aurora MySQL hostnames start with your database name and end with rds.amazonaws.com.

For example:
Host: mysql-rds-replica-1.xxxxxxxxx.rds.amazonaws.com
Port: 3306

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

  2. In the Databases section on the right, click the DB identifier of the Amazon Aurora MySQL instance.

    Select read replica instance

  3. Click the Connectivity & security tab, and copy the values under Endpoint and Port as the hostname and port number. You will specify these while creating your Hevo Pipeline.

    Copy endpoint & port


Specify Amazon Aurora MySQL Connection Settings

Specify the following settings in the Configure your Amazon Aurora MySQL Source page:

  • Pipeline Name: A unique name for your Pipeline.

  • Database Host: The MySQL host’s IP address or DNS.

    The following table lists a few examples of MySQL host:

    Variant Host
    Amazon RDS MySQL mysql-rds-1.xxxxx.rds.amazonaws.com
    Azure MySQL mysql.database.windows.net
    Generic MySQL 10.123.10.001 or mysql-replica.westeros.inc
    Google Cloud MySQL 35.220.150.0

    Note: For URL-based hostnames, exclude the http:// or https:// part. For example, if the hostname URL is http://mysql-replica.westeros.inc, enter mysql-replica.westeros.inc.

  • Database Port: The port on which your MySQL server is listening for connections. Default value: 3306.

  • Database User: The authenticated user that can read the tables in your database.

  • Database Password: Password for the database user.

  • Database Name: The database you want to load data from, if the Pipeline mode is Table or Custom SQL.

  • Connection Settings

    • Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your MySQL database host to Hevo. This provides an additional level of security to your database by not exposing your MySQL setup to the public. Read Connecting Through SSH.

      If this option is disabled, you must whitelist Hevo’s IP addresses. Refer to the content for your MySQL variant for steps to do this.

    • Use SSL: Enable it to use SSL encrypted connection. To enable this, specify the following:

      • CA File: The file containing the SSL server certificate authority (CA).

      • Client Certificate: The client public key certificate file.

      • Client Key: The client private key file.

  • Advanced Settings (for Pipelines with BinLog mode)

    • Load All Databases: Applicable for Pipelines with BinLog mode. If this option is enabled, Hevo loads the data from all databases on the selected host. Else, specify a comma-separated list of Database Names you want to load data from.

    • Load Historical Data: Applicable for Pipelines with BinLog mode. If this option is enabled, the entire table data is fetched during the first run of the Pipeline. If disabled, Hevo loads only the data that was written in your database after the time of creation of the Pipeline.

    • Merge Tables: Applicable for Pipelines with BinLog mode. If this option is enabled, Hevo merges tables with the same name from different databases while loading the data to the warehouse. Hevo loads the Database Name field with each record. If disabled, the database name is prefixed to each table name. Read How does the Merge Tables feature work?.

    • Include New Tables in the Pipeline: Applicable for all Pipeline modes except Custom SQL. If enabled, Hevo automatically ingests data from tables created after the Pipeline has been built. If disabled, the new tables are listed in the Pipeline Detailed View in Skipped state, and you can manually include the ones you want and load their historical data.

  • Click TEST & CONTINUE to proceed for setting up the Destination.


Limitations

  • Hevo only fetches tables from the MySQL database. It does not fetch other entities such as functions, stored procedures, views, and triggers.

    To fetch views, you can create individual Pipelines in Custom SQL mode. However, some limitations may arise based on the type of data synchronization, the query mode, or the number of Events. Contact Hevo Support for more details.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Aug-09-2021 NA Added a note in Step 3 of section, Create a Database User and Grant Privileges section.
Jul-26-2021 1.68 Added a note for the Database Host field.
Jul-12-2021 NA Added section, Specify Amazon Aurora MySQL Connection Settings.
Last updated on 19 Aug 2021