Skip to content

Commit 7f45644

Browse files
clark1013claude
andcommitted
cloud: mark Step 3 as optional in serverless private endpoint doc
Clarify that authorizing private endpoints is only needed when restricting access, and that leaving Authorized Networks empty allows all connections. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 92d27eb commit 7f45644

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

tidb-cloud/set-up-private-endpoint-connections-serverless.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To connect to your {{{ .starter }}} or {{{ .essential }}} instance via a private
4141

4242
1. [Choose a {{{ .starter }}} or Essential instance](#step-1-choose-a-tidb-instance)
4343
2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint)
44-
3. [Authorize your private endpoint in TiDB Cloud](#step-3-authorize-your-private-endpoint-in-tidb-cloud)
44+
3. [Authorize your private endpoint in TiDB Cloud (Optional)](#step-3-authorize-your-private-endpoint-in-tidb-cloud-optional)
4545
4. [Connect to your {{{ .starter }}} or Essential instance](#step-4-connect-to-your-tidb)
4646

4747
### Step 1. Choose a {{{ .starter }}} or Essential instance {#step-1-choose-a-tidb-instance}
@@ -103,9 +103,15 @@ aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${region_id} --serv
103103

104104
Then you can connect to the endpoint service with the private DNS name.
105105

106-
### Step 3. Authorize your private endpoint in TiDB Cloud
106+
### Step 3. Authorize your private endpoint in TiDB Cloud (Optional)
107107

108-
After creating the AWS interface endpoint, you must add it to the allowlist of your target {{{ .starter }}} or {{{ .essential }}} instance.
108+
<Info>
109+
110+
This step is optional. You only need to configure authorized networks when you want to restrict access to specific private endpoint connections. If no rules are configured, all private endpoint connections are allowed by default.
111+
112+
</Info>
113+
114+
After creating the AWS interface endpoint, you can add it to the allowlist of your target {{{ .starter }}} or {{{ .essential }}} instance to restrict access.
109115

110116
1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page.
111117
2. Click **Settings** > **Networking** in the left navigation pane.
@@ -117,8 +123,9 @@ After creating the AWS interface endpoint, you must add it to the allowlist of y
117123
- **Your VPC Endpoint ID**: paste your 22-character VPC Endpoint ID from the AWS Management Console (starts with `vpce-`).
118124

119125
> **Tip:**
120-
>
121-
> To allow all Private Endpoint connections from your cloud region (for testing or open access), enter a single asterisk (`*`) in the **Your VPC Endpoint ID** field.
126+
>
127+
> - If you leave the **Authorized Networks** table empty (that is, no rules are added), all private endpoint connections are allowed by default. You only need to add rules when you want to restrict access to specific private endpoint connections.
128+
> - To allow all Private Endpoint connections from your cloud region (for testing or open access), enter a single asterisk (`*`) in the **Your VPC Endpoint ID** field.
122129
123130
5. Click **Submit**.
124131

0 commit comments

Comments
 (0)