---
id: "aws-privatelink-service"
type: "component"
kind: "private-link"
provider: "aws"
category: "edge"
aliases: "PrivateLink"
docs: "https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html"
url: "https://localhost:3000/catalogue/components/aws-privatelink-service"
---

# PrivateLink endpoint service

Service shared with other accounts behind a Network Load Balancer.

| | |
|---|---|
| Provider | [aws](https://localhost:3000/catalogue?provider=aws) |
| Kind | [Private endpoint](https://localhost:3000/catalogue/kinds/private-link) |
| Category | Edge |
| Official docs | [https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `approvalRequired` | boolean | — | no | — | **true** |
| `crossRegion` | boolean | — | no | false | **false** |
| `crossZoneLoadBalancing` | boolean | — | no | false | inherited |
| `endpointCount` | integer | — | no | — | inherited |
| `frontEndLoadBalancer` | enum | `network-load-balancer`, `gateway-load-balancer` | no | "network-load-balancer" | inherited |
| `ipAddressType` | enum | `ipv4`, `ipv6`, `dualstack` | no | "ipv4" | inherited |
| `managed` | boolean | — | no | false | **true** |
| `privateDnsIntegration` | boolean | — | no | — | **false** |
| `publicAccessDisabled` | boolean | — | no | — | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 13

- [PrivateLink](https://localhost:3000/catalogue/components/alibaba-privatelink.md) `alibaba-privatelink` — alibabacloud
- [AWS RTB Fabric gateway](https://localhost:3000/catalogue/components/aws-rtb-fabric.md) `aws-rtb-fabric` — aws
- [AWS PrivateLink VPC endpoint](https://localhost:3000/catalogue/components/aws-vpc-endpoint.md) `aws-vpc-endpoint` — aws
- [Azure Private Link](https://localhost:3000/catalogue/components/azure-private-link.md) `azure-private-link` — azure
- [Cloudflare Tunnel](https://localhost:3000/catalogue/components/cloudflare-tunnel.md) `cloudflare-tunnel` — cloudflare
- [Workers VPC](https://localhost:3000/catalogue/components/cloudflare-workers-vpc.md) `cloudflare-workers-vpc` — cloudflare
- [Generic private endpoint](https://localhost:3000/catalogue/components/private-link.md) `private-link` — default
- [Private Service Connect](https://localhost:3000/catalogue/components/google-private-service-connect.md) `google-private-service-connect` — gcp
- [Serverless VPC Access connector](https://localhost:3000/catalogue/components/google-serverless-vpc-access-connector.md) `google-serverless-vpc-access-connector` — gcp
- [Virtual Private Endpoint Gateway](https://localhost:3000/catalogue/components/ibm-virtual-endpoint-gateway.md) `ibm-virtual-endpoint-gateway` — ibm
- [Private Endpoint](https://localhost:3000/catalogue/components/oci-private-endpoint.md) `oci-private-endpoint` — oci
- [Service Gateway](https://localhost:3000/catalogue/components/oci-service-gateway.md) `oci-service-gateway` — oci
- [OUTSCALE Net access point](https://localhost:3000/catalogue/components/outscale-net-access-point.md) `outscale-net-access-point` — outscale

## Use it in a design

```yaml
nodes:
  - { id: "aws-privatelink-service", component: "aws-privatelink-service" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# AWS PrivateLink endpoint service: a service you host behind a Network Load Balancer and share.
# "Share your services through AWS PrivateLink": consumers connect only after the provider grants
# permission, private DNS is opt-in, and cross-Region access requires an explicit IAM permission.
schemaVersion: "1"
type: "component"
id: "aws-privatelink-service"
kind: "private-link"
provider: "aws"
docs: "https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html"
aliases: ["PrivateLink"]
defaults:
  managed: true
  approvalRequired: true
  privateDnsIntegration: false
  crossRegion: false
properties:
  frontEndLoadBalancer:
    type: "enum"
    values: ["network-load-balancer", "gateway-load-balancer"]
    default: "network-load-balancer"
  ipAddressType:
    type: "enum"
    values: ["ipv4", "ipv6", "dualstack"]
    default: "ipv4"
  crossZoneLoadBalancing:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/components/aws-privatelink-service