Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
2f7c7ba
add plc
shiyuhang0 Dec 16, 2025
77059dc
opt
shiyuhang0 Dec 16, 2025
0479792
some fix
shiyuhang0 Dec 16, 2025
992882e
some fix
shiyuhang0 Dec 16, 2025
ca4dad3
add toc
shiyuhang0 Dec 16, 2025
4be169d
some fix by ai
shiyuhang0 Dec 17, 2025
f4c6bf0
Apply suggestions from code review
shiyuhang0 Dec 17, 2025
ca176a2
fix
shiyuhang0 Dec 17, 2025
ba55775
fix lint
shiyuhang0 Dec 17, 2025
a5d2ad4
fix according to the preview
shiyuhang0 Dec 17, 2025
ccfd4fe
Apply suggestions from code review
shiyuhang0 Dec 17, 2025
a0ef99a
Update Alibaba Cloud RDS private link setup docs
hfxsd Dec 18, 2025
aed869e
Update tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 19, 2025
f6fe625
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 19, 2025
203e2eb
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 19, 2025
56e443e
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 19, 2025
fc113a1
Update docs for Private Link Connection setup
hfxsd Dec 19, 2025
6466583
remove subnet group in alicloud rds
shiyuhang0 Dec 19, 2025
c2f9643
add link for subnet grup
shiyuhang0 Dec 19, 2025
156c135
add alicloud self-hosted kafka
shiyuhang0 Dec 23, 2025
4c5a5fa
some opt
shiyuhang0 Dec 23, 2025
ff6d3c0
Update private link connection docs for clarity and accuracy
hfxsd Dec 23, 2025
cd7c7ab
Merge branch 'private-link-connection' of https://github.com/shiyuhan…
hfxsd Dec 23, 2025
adfe661
Revise and clarify private link connection guides
hfxsd Dec 23, 2025
5b53ba7
Update serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
hfxsd Dec 23, 2025
319e2f6
Update serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
hfxsd Dec 24, 2025
470d9ab
Update Alibaba Cloud and AWS private link docs for clarity
hfxsd Dec 24, 2025
d097da9
some opts for confluent
shiyuhang0 Dec 24, 2025
102aa34
some opts for confluent
shiyuhang0 Dec 24, 2025
fdb5c9d
fix provider in alibaba kafka
shiyuhang0 Dec 24, 2025
2b4e737
fix
shiyuhang0 Dec 24, 2025
d3c26e9
fix
shiyuhang0 Dec 24, 2025
724506b
Update TOC-tidb-cloud-essential.md
shiyuhang0 Dec 25, 2025
6f79fe1
opt see also
shiyuhang0 Dec 25, 2025
6b55ecd
Update tidb-cloud/serverless-private-link-connection.md
hfxsd Dec 26, 2025
a198ed6
Update serverless-private-link-connection.md
hfxsd Dec 26, 2025
9883e04
Document Private Link Connections for Dataflow (Beta)
hfxsd Dec 26, 2025
5f9b0d2
Update AWS Confluent and private link connection docs
hfxsd Dec 26, 2025
bdf8b07
Revise private link connection docs for clarity
hfxsd Dec 26, 2025
ffc965d
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 26, 2025
e1dcf14
Refactor and clarify private link domain attachment steps
hfxsd Dec 29, 2025
0e69be8
Update serverless-private-link-connection-to-aws-rds.md
hfxsd Dec 29, 2025
964c53c
some fix
shiyuhang0 Dec 29, 2025
341d238
Apply suggestions from code review
shiyuhang0 Dec 29, 2025
7416871
some fix
shiyuhang0 Dec 29, 2025
349bd46
opt ali rds network
shiyuhang0 Dec 29, 2025
d71b9e8
try to fix verify
shiyuhang0 Dec 29, 2025
c1fb427
try to fix verify
shiyuhang0 Dec 29, 2025
96427b9
Apply suggestions from code review
shiyuhang0 Dec 29, 2025
1bd17c3
add confleunt unique name link
shiyuhang0 Dec 29, 2025
f5535a2
fix dead link
shiyuhang0 Dec 29, 2025
54feec2
Restructure and clarify private link connection setup docs
hfxsd Dec 29, 2025
424efe7
Update Private Link connection docs for clarity and conciseness
hfxsd Dec 29, 2025
e53e54f
Apply suggestions from code review
hfxsd Dec 29, 2025
ac95e4c
Update tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
shiyuhang0 Dec 29, 2025
bf32079
add create confluent dedicated cluster
shiyuhang0 Dec 29, 2025
25416dc
fix verify
shiyuhang0 Dec 29, 2025
68664a2
Apply suggestions from code review
shiyuhang0 Dec 29, 2025
365607c
opt endpoint service request
shiyuhang0 Dec 29, 2025
14def46
Apply suggestions from code review
hfxsd Dec 29, 2025
e2d11ad
Apply suggestions from code review
hfxsd Dec 29, 2025
83d4ac4
Apply suggestions from code review
hfxsd Dec 29, 2025
6f81c0c
Remove serverless private link connection docs
hfxsd Dec 30, 2025
c258c10
Update TOC-tidb-cloud-essential.md
hfxsd Dec 30, 2025
6e7e9eb
Apply suggestions from code review
hfxsd Dec 30, 2025
a6b594e
Apply suggestions from code review
hfxsd Dec 30, 2025
7cd677e
Apply suggestions from code review
hfxsd Dec 30, 2025
70e80ce
Merge branch 'release-8.5' into pr/22192
hfxsd Dec 31, 2025
0978607
Revise private link connection guides for clarity
hfxsd Dec 31, 2025
3aeb400
Clarify setup steps for RDS endpoint services
hfxsd Dec 31, 2025
561d9ff
refine wording
hfxsd Dec 31, 2025
a6c8f42
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 31, 2025
3401088
Clarify setup steps for private link connections
hfxsd Dec 31, 2025
7640b22
Fix security group rule formatting in AWS RDS guide
hfxsd Dec 31, 2025
b272a54
Update serverless-private-link-connection-to-aws-rds.md
hfxsd Dec 31, 2025
4b3477d
Remove commented-out block from See also section
hfxsd Dec 31, 2025
e667f59
Update TOC-tidb-cloud-essential.md
hfxsd Dec 31, 2025
9698783
Update serverless-private-link-connection-to-aws-rds.md
hfxsd Dec 31, 2025
551ce97
Update serverless-private-link-connection-to-aws-rds.md
hfxsd Dec 31, 2025
3b9ad26
Update serverless-private-link-connection.md
hfxsd Dec 31, 2025
2e28d8a
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd Dec 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions TOC-tidb-cloud-essential.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,11 @@
- [TLS Connections to TiDB Cloud](/tidb-cloud/secure-connections-to-serverless-clusters.md)
- Private Link Connection
- [Private Link Connection Overview](/tidb-cloud/serverless-private-link-connection.md)
- [Connect to Amazon RDS](/tidb-cloud/serverless-private-link-connection-to-aws-rds.md)
- [Connect to Alibaba Cloud RDS](/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md)
- [Connect to Confluent Cloud on AWS](/tidb-cloud/serverless-private-link-connection-to-aws-confluent.md)
- [Connect to Self-Hosted Kafka on Alibaba Cloud](/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md)
- [Connect to Self-Hosted Kafka on AWS](/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md)
- Audit Management
- [Console Audit Logging](/tidb-cloud/tidb-cloud-console-auditing.md)
- [Database Audit Logging](/tidb-cloud/essential-database-audit-logging.md)
Expand Down
95 changes: 95 additions & 0 deletions tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection
summary: Learn how to connect to an Alibaba Cloud ApsaraDB RDS for MySQL instance using an Alibaba Cloud Endpoint Service private link connection.
---

# Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection

This document describes how to connect a {{{ .essential }}} cluster to an [Alibaba Cloud ApsaraDB RDS for MySQL](https://www.alibabacloud.com/en/product/apsaradb-for-rds-mysql) instance using an Alibaba Cloud Endpoint Service private link connection.

## Prerequisites

- You have an existing ApsaraDB RDS for MySQL instance or the permissions required to create one.

- Verify that your account has the following permissions to manage networking components:

- Manage load balancer
- Manage endpoint services

- Your {{{ .essential }}} cluster is on Alibaba Cloud, and it is active. Retrieve and save the following details for later use:

- Account ID
- Availability Zones (AZ)

To view the the Alibaba Cloud account ID and availability zones, do the following:

1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**.
3. In the displayed dialog, you can find the Alibaba Cloud account ID and availability zones.

## Step 1. Set up an ApsaraDB RDS for MySQL instance

Identify an Alibaba Cloud ApsaraDB RDS for MySQL that you want to use, or [create a new RDS](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/step-1-create-an-apsaradb-rds-for-mysql-instance-and-configure-databases).

Your ApsaraDB RDS for MySQL instance must meet the following requirements:

- Region match: the instance must reside in the same Alibaba Cloud region as your {{{ .essential }}} cluster.
- AZ (Availability Zone) availability: the availability zones must overlap with those of your {{{ .essential }}} cluster.
- Network accessibility: the instance must be configured with proper IP whitelist and be accessible within the VPC.

> **Note**
>
> Cross-region connections for ApsaraDB RDS for MySQL are not supported.

## Step 2. Expose the ApsaraDB RDS for MySQL instance as an endpoint service

You need to set up the load balancer and the endpoint service in the Alibaba Cloud console.

### Step 2.1. Set up the load balancer

Set up the load balancer in the same region of your ApsaraDB RDS for MySQL as follows:

1. Go to [Server Groups](https://slb.console.alibabacloud.com/nlb/ap-southeast-1/server-groups) to create a server group. Provide the following information:

- **Server Group Type**: select `IP`
- **VPC**: enter the VPC where your ApsaraDB RDS for MySQL is located
- **Backend Server Protocol**: select `TCP`

2. Click the created server group to add backend servers, and then add the IP address of your ApsaraDB RDS for MySQL instance.

You can ping the RDS endpoint to get the IP address.

3. Go to [NLB](https://slb.console.alibabacloud.com/nlb) to create a network load balancer. Provide the following information:

- **Network Type**: select `Internal-facing`
- **VPC**: select the VPC where your ApsaraDB RDS for MySQL is located
- **Zone**: it must overlap with your {{{ .essential }}} cluster
- **IP Version**: select `IPv4`

4. Find the load balancer you created, and then click **Create Listener**. Provide the following information:

- **Listener Protocol**: select `TCP`
- **Listener Port**: enter the database port, for example, `3306` for MySQL
- **Server Group**: choose the server group you created in the previous step

### Step 2.2. Set up an endpoint service

To set up the endpoint service in the same region of your ApsaraDB RDS for MySQL, take the following steps:

1. Go to [Endpoint Service](https://vpc.console.alibabacloud.com/endpointservice) to create an endpoint service. Provide the following information:

- **Service Resource Type**: select `NLB`
- **Select Service Resource**: select all zones that NLB is in, and choose the NLB that you created in the previous step
- **Automatically Accept Endpoint Connections**: it is recommended to choose `No`

2. Go to the details page of the endpoint service, and copy the **Endpoint Service Name**, for example, `com.aliyuncs.privatelink.<region>.xxxxx`. You need to use it for TiDB Cloud later.

3. On the detail page of the endpoint service, click the **Service Whitelist** tab, click **Add to Whitelist**, and then enter the TiDB Cloud account ID.

For more information about how to get the account ID, see [Prerequisites](#prerequisites).

## Step 3. Create a private link connection in TiDB Cloud

You can create a private link connection using the TiDB Cloud console or the TiDB Cloud CLI.

For more information, see [Create an Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md#create-an-alibaba-cloud-endpoint-service-private-link-connection).
114 changes: 114 additions & 0 deletions tidb-cloud/serverless-private-link-connection-to-aws-rds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: Connect to Amazon RDS via a Private Link Connection
summary: Learn how to connect to an Amazon RDS instance using an AWS Endpoint Service private link connection.
---

# Connect to Amazon RDS via a Private Link Connection

This document describes how to connect a {{{ .essential }}} cluster to an [Amazon RDS](https://aws.amazon.com/rds/) instance using an AWS Endpoint Service private link connection.

## Prerequisites

- You have an existing Amazon RDS instance or the permissions required to create one.

- Your account has the following permissions to manage networking components:

- Manage security groups
- Manage load balancer
- Manage endpoint services

- Your {{{ .essential }}} is hosted on AWS, and it is active. Retrieve and save the following details for later use:

- AWS Account ID
- Availability Zones (AZ)

To view the the AWS account ID and availability zones, do the following:

1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**.
3. In the displayed dialog, you can find the AWS account ID and availability zones.

## Step 1. Set up the Amazon RDS instance

Identify an Amazon RDS instance to use, or [create a new one](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html).

The Amazon RDS instance must meet the following requirements:

- Region match: the instance must reside in the same AWS region as your {{{ .essential }}} cluster.
- The [subnet group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) of your Amazon RDS instance must have overlapping availability zones as your {{{ .essential }}} cluster.
- Set your Amazon RDS instance with a proper security group, and it is accessible within the VPC. For example, you can create a security group with the following rules:

- An inbound rule that allows MySQL/Aurora:
- Type: `MySQL/Aurora`
- Source: `Anywhere-IPv4`

- An outbound rule that allows MySQL/Aurora:
- Type: `MySQL/Aurora`
- Destination: `Anywhere-IPv4`

> **Note**
>
> To connect to a cross-region RDS instance, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).

## Step 2. Expose the Amazon RDS instance as an endpoint service

You need to set up the load balancer and the AWS Endpoint Service in the AWS console.

### Step 2.1. Set up the load balancer

To set up the load balancer in the same region of your RDS, take the following steps:

1. Go to [Target groups](https://console.aws.amazon.com/ec2/home#CreateTargetGroup) to create a target group. Provide the following information:

- **Target type**: select `IP addresses`
- **Protocol and Port**: set the protocol to `TCP` and the port to your database port, for example `3306` for MySQL.
- **IP address type**: select `IPv4`
- **VPC**: select the VPC where your RDS is located
- **Register targets**: register the IP addresses of your Amazon RDS instance. You can ping the RDS endpoint to get the IP address.

For more information, see [Create a target group for your Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-target-group.html).

2. Go to [Load balancers](https://console.aws.amazon.com/ec2/home#LoadBalancers) to create a network load balancer. Provide the following information:

- **Schema**: select `Internal`
- **Load balancer IP address type**: select `IPv4`
- **VPC**: select the VPC where your RDS is located
- **Availability Zones**: it must overlap with your {{{ .essential }}} cluster
- **Security groups**: create a new security group with the following rules:
- An inbound rule that allows MySQL/Aurora:
- Type: `MySQL/Aurora`
- Source: `Anywhere-IPv4`

- An outbound rule that allows MySQL/Aurora:
- Type: `MySQL/Aurora`
- Destination: `Anywhere-IPv4`

- **Listeners and routing**:
- **Protocol and Port**: set the protocol to `TCP` and the port to your database port, for example `3306` for MySQL
- **Target group**: select the target group that you create in the previous step

For more information, see [Create a Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-network-load-balancer.html).

### Step 2.2. Set up the AWS Endpoint Service

To set up the endpoint service in the same region of your RDS, take the following steps:

1. Go to [Endpoint services](https://console.aws.amazon.com/vpcconsole/home#EndpointServices) to create an endpoint service. Provide the following information:

- **Load balancer type**: select `Network`
- **Available load balancers**: enter the load balancer you create in the previous step
- **Supported Regions**: leave it empty if you do not have cross-region requirements
- **Require acceptance for endpoint**: it is recommended to select `Acceptance required`
- **Supported IP address types**: select `IPv4`

2. Go to the details page of the endpoint service, and then copy the endpoint service name, in the format of `com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxxx`. You need to provide it to TiDB Cloud.

3. On the details page of the endpoint service, click the **Allow principals** tab, and then add the TiDB Cloud account ID to the allowlist, for example, `arn:aws:iam::<account_id>:root`.

You can get the AWS account ID in [Prerequisites](#prerequisites).

## Step 3. Create an AWS Endpoint Service private link connection in TiDB Cloud

You can create a private link connection using the TiDB Cloud console or the TiDB Cloud CLI.

For more information, see [Create an AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md#create-an-aws-endpoint-service-private-link-connection).
Loading
Loading