AWS RDS and Aurora

AWS RDS and Aurora

Connect Hyperdrive to an AWS RDS or AWS Aurora MySQL database instance.

Last updated Sep 16, 2026 This example shows you how to connect Hyperdrive to an Amazon Relational Database Service (Amazon RDS) or Amazon Aurora MySQL database instance.

1. Allow Hyperdrive access

To allow Hyperdrive to connect to your database, you will need to ensure that Hyperdrive has valid user credentials and network access.

Note

To allow Hyperdrive to connect to your database, you must allow Cloudflare IPs to be able to access your database. You can either allow-list all IP address ranges (0.0.0.0 - 255.255.255.255) or restrict your IP access control list to the IP ranges used by Hyperdrive.

Alternatively, you can connect to your databases over in your private network using Cloudflare Tunnels.

AWS Console

When creating or modifying an instance in the AWS console:

Configure a database cluster and other settings you wish to customize.
Under Settings > Credential settings, note down the Master username and Master password (Aurora only).
Under the Connectivity header, ensure Public access is set to Yes.
Select an Existing VPC security group that allows public Internet access from 0.0.0.0/0 to the port your database instance is configured to listen on (default: 3306 for MySQL instances).
Select Create database.

Caution

You must ensure that the VPC security group ↗︎ associated with your database allows public IPv4 access to your database port.

Refer to AWS' database server rules ↗︎ for details on how to configure rules specific to your RDS database.

Retrieve the database endpoint (Aurora)

To retrieve the database endpoint (hostname) for Hyperdrive to connect to:

Go to Databases view under RDS in the AWS console.
Select the database you want Hyperdrive to connect to.
Under the Endpoints header, note down the Endpoint name with the type Writer and the Port.

Retrieve the database endpoint (RDS MySQL)

For regular RDS instances (non-Aurora), you will need to fetch the endpoint and port of the database:

Go to Databases view under RDS in the AWS console.
Select the database you want Hyperdrive to connect to.
Under the Connectivity & security header, note down the Endpoint and the Port.

The endpoint will resemble YOUR_DATABASE_NAME.cpuo5rlli58m.AWS_REGION.rds.amazonaws.com, and the port will default to 3306.

2. Create your user

Once your database is created, you will need to create a user for Hyperdrive to connect as. Although you can use the Master username configured during initial database creation, best practice is to create a less privileged user.

To create a new user, log in to the database and use the CREATE USER command:

# Log in to the database
mysql -h ENDPOINT_NAME -P PORT -u MASTER_USERNAME -p database_name

Run the following SQL statements:

-- Create a role for Hyperdrive
CREATE ROLE hyperdrive;

-- Allow Hyperdrive to connect
GRANT USAGE ON mysql_db.* TO hyperdrive;

-- Grant database privileges to the hyperdrive role
GRANT ALL PRIVILEGES ON mysql_db.* to hyperdrive;

-- Create a specific user for Hyperdrive to log in as
CREATE USER 'hyperdrive_user'@'%' IDENTIFIED WITH caching_sha2_password BY 'sufficientlyRandomPassword';

-- Grant this new user the hyperdrive role privileges
GRANT hyperdrive to 'hyperdrive_user'@'%';

Refer to AWS' documentation on user roles in MySQL ↗︎ for more details.

With a database user, password, database endpoint (hostname and port), and database name, you can now set up Hyperdrive.

3. Create a database configuration

To configure Hyperdrive, you will need:

The IP address (or hostname) and port of your database.
The database username (for example, hyperdrive-demo) you configured in a previous step.
The password associated with that username.
The name of the database you want Hyperdrive to connect to. For example, mysql.

Hyperdrive accepts the combination of these parameters in the common connection string format used by database drivers:

mysql://USERNAME:PASSWORD@HOSTNAME_OR_IP_ADDRESS:PORT/database_name

Most database providers will provide a connection string you can copy-and-paste directly into Hyperdrive.

To create a Hyperdrive configuration with the Wrangler CLI, open your terminal and run the following command.

Replace \<NAME_OF_HYPERDRIVE_CONFIG> with a name for your Hyperdrive configuration and paste the connection string provided from your database host, or,
Replace user, password, HOSTNAME_OR_IP_ADDRESS, port, and database_name placeholders with those specific to your database:

npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="mysql://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

Note

Hyperdrive will attempt to connect to your database with the provided credentials to verify they are correct before creating a configuration. If you encounter an error when attempting to connect, refer to Hyperdrive's troubleshooting documentation to debug possible causes.

This command outputs a binding for the Wrangler configuration file:

{
    "$schema": "./node_modules/wrangler/config-schema.json",
    "name": "hyperdrive-example",
    "main": "src/index.ts",
    "upload_source_maps": true,
    // Set this to today's date
    "compatibility_date": "2026-10-27",
    "compatibility_flags": [
        "nodejs_compat"
    ],
    // Pasted from the output of `wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string=[...]` above.
    "hyperdrive": [
        {
            "binding": "HYPERDRIVE",
            "id": "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"
        }
    ]
}

"$schema" = "./node_modules/wrangler/config-schema.json"
name = "hyperdrive-example"
main = "src/index.ts"
upload_source_maps = true
# Set this to today's date
compatibility_date = "2026-10-27"
compatibility_flags = [ "nodejs_compat" ]

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"

3. Use Hyperdrive from your Worker

Install the mysql2 ↗︎ driver:

npmyarnpnpmbun

npm i mysql2@>3.13.0

yarn add mysql2@>3.13.0

pnpm add mysql2@>3.13.0

bun add mysql2@>3.13.0

Note

mysql2 v3.13.0 or later is required

Add the required Node.js compatibility flags and Hyperdrive binding to your wrangler.jsonc file:

{
    // required for database drivers to function
    "compatibility_flags": [
        "nodejs_compat"
    ],
    // Set this to today's date
    "compatibility_date": "2026-10-27",
    "hyperdrive": [
        {
            "binding": "HYPERDRIVE",
            "id": "<your-hyperdrive-id-here>"
        }
    ]
}

compatibility_flags = [ "nodejs_compat" ]
# Set this to today's date
compatibility_date = "2026-10-27"

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<your-hyperdrive-id-here>"

Create a new connection instance and pass the Hyperdrive parameters:

// mysql2 v3.13.0 or later is required
import { createConnection } from "mysql2/promise";

export default {
    async fetch(request, env, ctx): Promise<Response> {
        // Create a new connection on each request. Hyperdrive maintains the underlying
        // database connection pool, so creating a new connection is fast.
        const connection = await createConnection({
            host: env.HYPERDRIVE.host,
            user: env.HYPERDRIVE.user,
            password: env.HYPERDRIVE.password,
            database: env.HYPERDRIVE.database,
            port: env.HYPERDRIVE.port,

            // Required to enable mysql2 compatibility for Workers
            disableEval: true,
        });

        try {
            // Sample query
            const [results, fields] = await connection.query("SHOW tables;");

            // Return result rows as JSON
            return Response.json({ results, fields });
        } catch (e) {
            console.error(e);
            return Response.json(
                { error: e instanceof Error ? e.message : e },
                { status: 500 },
            );
        }
    },
} satisfies ExportedHandler<Env>;

Note

The minimum version of mysql2 required for Hyperdrive is 3.13.0.

Next steps

Learn more about How Hyperdrive Works.
Refer to the troubleshooting guide to debug common issues.
Understand more about other storage options available to Cloudflare Workers.

Was this helpful?

YesNo

{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/hyperdrive/examples/connect-to-mysql/mysql-database-providers/aws-rds-aurora/#page","headline":"AWS RDS and Aurora","description":"Connect Hyperdrive to an AWS RDS database instance.","url":"https://developers.cloudflare.com/hyperdrive/examples/connect-to-mysql/mysql-database-providers/aws-rds-aurora/","inLanguage":"en","image":"https://developers.cloudflare.com/hyperdrive/examples/connect-to-mysql/mysql-database-providers/aws-rds-aurora/og.png?v=6e74cc61de396fea","dateModified":"2026-09-16","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}

description: Connect Hyperdrive to a Azure Database for MySQL instance. title: Azure Database image: https://developers.cloudflare.com/hyperdrive/examples/connect-to-mysql/mysql-database-providers/azure/og.png?v=84567c1525697836

Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/hyperdrive/llms.txt
Use this file to discover all available pages before exploring further.

AWS RDS and Aurora

AWS RDS and Aurora

1. Allow Hyperdrive access

AWS Console

Retrieve the database endpoint (Aurora)

Retrieve the database endpoint (RDS MySQL)

2. Create your user

3. Create a database configuration

3. Use Hyperdrive from your Worker

Next steps

On this page