AWS PrivateLink VPC endpoint

awsPrivate endpointaws-vpc-endpoint

Private connection from VPC subnets to a service, without an internet gateway.

Provider
aws
Category
Edge
Also known as
VPCE
Properties · 3 set by this component
propertytypevaluesrequiredkind defaultthis component
approvalRequiredboolean—no—▸ false
crossRegionboolean—nofalse▸ false
endpointCountinteger—no—inherited
endpointType · component propertyenuminterface | gateway | gateway-load-balancernointerfaceinherited
ipAddressType · component propertyenumipv4 | ipv6 | dualstacknoipv4inherited
managedboolean—nofalse▸ true
privateDnsIntegrationboolean—no—inherited
publicAccessDisabledboolean—no—inherited
requiresInternetGateway · component propertyboolean—nofalseinherited
serviceInitiatedRequests · component propertyboolean—nofalseinherited
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: "vpc-endpoint", component: "aws-vpc-endpoint" }
Other Private endpoint products · 13
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# AWS PrivateLink VPC endpoint: private connection from subnets in a VPC to a service.
# "Access AWS services through AWS PrivateLink": an interface endpoint needs no internet gateway or NAT,
# AWS services accept connection requests automatically, and the endpoint IP address type defaults to IPv4.
schemaVersion: "1"
type: "component"
id: "aws-vpc-endpoint"
kind: "private-link"
provider: "aws"
docs: "https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-aws-services.html"
aliases: ["VPCE"]
defaults:
  managed: true
  approvalRequired: false
  crossRegion: false
properties:
  endpointType:
    type: "enum"
    values: ["interface", "gateway", "gateway-load-balancer"]
    default: "interface"
  ipAddressType:
    type: "enum"
    values: ["ipv4", "ipv6", "dualstack"]
    default: "ipv4"
  requiresInternetGateway:
    type: "boolean"
    default: false
  serviceInitiatedRequests:
    type: "boolean"
    default: false

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