> ## Documentation Index
> Fetch the complete documentation index at: https://docs.traversal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PrivateLink

> Establish AWS PrivateLink connections between your VPC and your dedicated Traversal deployment (single-tenant SaaS or BYOC) so traffic to Traversal services stays on the AWS private network.

AWS PrivateLink connects your VPCs to Traversal's dedicated deployments (single-tenant SaaS and BYOC) over the AWS network, with no public IPs, internet gateways, or VPC peering. Traversal exposes four endpoint services: its web application, API, Edge (for the Connector), and Ingest (for the Processor). You deploy a CloudFormation template that Traversal publishes. It creates one VPC Interface Endpoint per service and attaches the security groups you supply, so you control access to each service separately. Each security group must allow inbound HTTPS (port 443) from the CIDR ranges that need to reach that service. Traversal-supplied hostnames resolve to private IPs inside your VPC, and only in VPCs you authorize. The wildcard server certificate is issued by your own CA against a domain you own. For an architectural overview, see [single-tenant SaaS](https://docs.traversal.com/architecture/single-tenant-saas.md) or [Bring Your Own Cloud](https://docs.traversal.com/architecture/byoc.md).

![Dedicated Deployment AWS PrivateLink Architecture](https://mintcdn.com/traversal-ff380fca/_vYTU6xQ3lzRQ7XS/setup/privatelink-architecture.png?fit=max\&auto=format\&n=_vYTU6xQ3lzRQ7XS\&q=85\&s=f2cb793e9a1ecb901a35f0ab4ef74ac6)

> [!NOTE]
>
> Multi-VPC access: Repeat the deployment steps in each VPC where Traversal services need to be reachable. Each VPC needs its own set of four Interface Endpoints and its own association with the private hosted zone.

## Before you begin

Traversal shares the following with you through a secure channel during onboarding of your dedicated deployment:

* **Endpoint Service names**: one per service (`api`, `app`, `edge`, `ingest`), in the form `com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxxx`.
* **A Route53 private hosted zone ID** and its **four nameservers**.
* **The subdomain** that resolves the Traversal endpoints (for example, `traversal.<your-company>.com`).

On your side, you'll need:

* An AWS account, and a VPC where the Interface Endpoints will live.
* Subnet IDs in that VPC (one per AZ recommended).
* The CIDR ranges of every client network that should reach the endpoints.
* A parent zone you control where you can add a delegating `NS` record.

## DNS resolution

Traversal creates a private Route53 hosted zone for a subdomain and shares four nameservers with you. You add an NS record on your parent zone pointing at those nameservers, delegating the subdomain to Traversal.

Delegating a subdomain you own, such as `traversal.<your-company>.com`, puts Traversal service hostnames under your domain.
Traversal then populates the hosted zone with CNAME records pointing to your Interface Endpoint DNS names, which in turn resolve to the private IP of the endpoint inside your VPC. These hostnames only resolve inside VPCs that are associated with the hosted zone and are not resolvable from the public internet.

## Deployment

**1. Delegate the subdomain to Traversal**

On your parent zone, add an `NS` record for your delegated subdomain pointing at the four nameservers Traversal shared with you.

**2. Deploy the CloudFormation template**

Deploy the PrivateLink consumer CloudFormation template ([https://templates.traversal.com/traversal-privatelink-consumer.yaml](https://templates.traversal.com/traversal-privatelink-consumer.yaml)) in the AWS account and region where the Interface Endpoints will live. Pass the four `*EndpointServiceName` values Traversal shared with you, along with your VPC ID, subnet IDs, and the CIDR ranges of clients that should reach the endpoints.

The stack outputs include one DNS name per service (`ApiEndpointDnsName`, `AppEndpointDnsName`, `EdgeEndpointDnsName`, `IngestEndpointDnsName`).

**3. Associate each authorized VPC with the private hosted zone**

Share your VPC IDs and regions with Traversal. After Traversal authorizes them, run this command from your account for each VPC:

```bash theme={null}
aws route53 associate-vpc-with-hosted-zone \
  --hosted-zone-id <hosted-zone-id> \
  --vpc VPCRegion=<region>,VPCId=<vpc-id>
```

**4. Send the endpoint DNS names to Traversal**

Share the four `*EndpointDnsName` outputs from the CloudFormation stack with Traversal. Traversal creates the CNAMEs in the private hosted zone so `<svc>.<your-subdomain>` resolves to your Interface Endpoint.

## DNS-only VPC access

If a VPC only needs to resolve Traversal hostnames (for example, an admin VPC), you can authorize it without deploying Interface Endpoints. Share the VPC IDs and regions with Traversal, who authorize them on their side. Then run the following from your account for each VPC:

```bash theme={null}
aws route53 associate-vpc-with-hosted-zone \
  --hosted-zone-id <hosted-zone-id> \
  --vpc VPCRegion=<region>,VPCId=<vpc-id>
```

Once associated, DNS queries for the Traversal subdomain resolve inside that VPC without Interface Endpoints.

## More information

> [card] [Single-tenant SaaS architecture](https://docs.traversal.com/architecture/single-tenant-saas.md)
>
> How Traversal single-tenant SaaS is deployed in Traversal's own cloud account, what's in scope, and the security boundary.

> [card] [BYOC architecture](https://docs.traversal.com/architecture/byoc.md)
>
> How Traversal BYOC is deployed in your AWS account, what's in scope, and the security boundary.

> [card] [AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/)
>
> AWS documentation on PrivateLink, Interface Endpoints, and Endpoint Services.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.