Skip to content

docs: fix <byoc-region> in the AWS private link doc #9844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2025
Merged

docs: fix <byoc-region> in the AWS private link doc #9844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/pages/product/deployment/cloud/byoc/aws/privatelink.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ To enable proper hostname resolution, create a private Route 53 hosted zone:
- **Domain name**: `<byoc-region>.cubecloudapp.dev`
- **Type**: Private hosted zone
- **VPCs**: Associate with your target VPC(s)

<InfoBox>

The `<byoc-region>` placeholder in the domain name should be replaced with the exact region identifier provided by Cube Cloud support. This is **not** the standard AWS region name (like `us-east-1`), but rather a Cube Cloud-specific identifier that uniquely identifies your BYOC infrastructure provisioning.

For example, if Cube Cloud provides you with a region identifier like `aws-us-east-1-t-12345-prod`, you would use that exact string in place of `<byoc-region>`.

</InfoBox>

4. Create the following DNS records in the zone:

| Record Name | Type | Value |
Expand All @@ -74,6 +83,8 @@ To enable proper hostname resolution, create a private Route 53 hosted zone:
| `*.sql.<byoc-region>.cubecloudapp.dev` | A | Alias to SQL VPC endpoint |
| `sql.<byoc-region>.cubecloudapp.dev` | A | Alias to SQL VPC endpoint |

**Note**: Each BYOC infrastructure provisioning will have a different region identifier. If you provision additional regions in the future, each will require its own private zone with the corresponding region-specific identifier.

### Step 4: Verify connectivity

To test the connection from within your VPC, obtain the test connection commands from the Cube Cloud UI:
Expand Down