docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx
Cube Cloud BYOC deployments on AWS support private connectivity for Cube API endpoints using AWS PrivateLink. This enables secure, private access to your Cube deployment without exposing endpoints to the public internet.
<Note>Available on the Enterprise plan with BYOC deployments. Contact us for details.
</Note>In a private setup, Cube Cloud BYOC deployments can be configured to:
This approach ensures that all traffic between your applications and Cube Cloud remains within the AWS network backbone, never traversing the public internet.
With private connectivity enabled, Cube Cloud exposes two AWS PrivateLink services:
Your Cube deployment APIs are available on dedicated hostnames following this pattern:
<deployment-id>.<byoc-region>.cubecloudapp.dev<deployment-id>.sql.<byoc-region>.cubecloudapp.devContact Cube Cloud support to obtain the PrivateLink service details for your BYOC deployment. You'll receive:
In your AWS account, create two VPC endpoints for the Cube Cloud services:
To enable proper hostname resolution, create a private Route 53 hosted zone:
<byoc-region>.cubecloudapp.devThe <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 provisioned.
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>.
Create the following DNS records in the zone:
| Record Name | Type | Value |
|---|---|---|
*.<byoc-region>.cubecloudapp.dev | A | Alias to HTTP VPC endpoint |
*.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.
To test the connection from within your VPC, obtain the test connection commands from the Cube Cloud UI:
The Cube Cloud web interface requires access to live Cube APIs to function properly. In a private setup, these APIs aren't accessible from user browsers by default, which would limit Cube Cloud functionality.
To enable full Cube Cloud UI functionality, you need to establish PrivateLink endpoints within your corporate network:
Cube Cloud's custom domains feature is not compatible with PrivateLink connectivity. This limitation exists because:
If you require custom domains, consider using Cube Cloud's standard public endpoints with appropriate security controls.
DNS resolution failures
nslookup or dig from within the VPCConnection timeouts
Certificate errors
*.cubecloudapp.dev domainsFor assistance with PrivateLink setup:
nslookup output)