PrivateLink endpoint service

aws Private endpointaws-privatelink-service

Service shared with other accounts behind a Network Load Balancer.

Provider: aws
Kind: Private endpoint
Category: Edge
Official docs: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html

Properties · 4 set by this component

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

Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.

Use it in a design

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

Other Private endpoint products · 13

PrivateLinkalibaba-privatelinkalibabacloudprivate-link AWS RTB Fabric gatewayaws-rtb-fabricawsprivate-link AWS PrivateLink VPC endpointaws-vpc-endpointawsprivate-link Azure Private Linkazure-private-linkazureprivate-link Cloudflare Tunnelcloudflare-tunnelcloudflareprivate-link Workers VPCcloudflare-workers-vpccloudflareprivate-link Generic private endpointprivate-linkprivate-link Private Service Connectgoogle-private-service-connectgcpprivate-link Serverless VPC Access connectorgoogle-serverless-vpc-access-connectorgcpprivate-link Virtual Private Endpoint Gatewayibm-virtual-endpoint-gatewayibmprivate-link Private Endpointoci-private-endpointociprivate-link Service Gatewayoci-service-gatewayociprivate-link OUTSCALE Net access pointoutscale-net-access-pointoutscaleprivate-link

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# AWS PrivateLink endpoint service: a service you host behind a Network Load Balancer and share.
3# "Share your services through AWS PrivateLink": consumers connect only after the provider grants
4# permission, private DNS is opt-in, and cross-Region access requires an explicit IAM permission.
5schemaVersion: "1"
6type: "component"
7id: "aws-privatelink-service"
8kind: "private-link"
9provider: "aws"
10docs: "https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html"
11aliases: ["PrivateLink"]
12defaults:
13  managed: true
14  approvalRequired: true
15  privateDnsIntegration: false
16  crossRegion: false
17properties:
18  frontEndLoadBalancer:
19    type: "enum"
20    values: ["network-load-balancer", "gateway-load-balancer"]
21    default: "network-load-balancer"
22  ipAddressType:
23    type: "enum"
24    values: ["ipv4", "ipv6", "dualstack"]
25    default: "ipv4"
26  crossZoneLoadBalancing:
27    type: "boolean"
28    default: false

The same page as markdown, for an agent: /catalogue/components/aws-privatelink-service.md