privatelinkendpoint.md

PrivateLinkEndpoint

A PrivateLink endpoint, which connects a project to an AWS VPC endpoint service in a single region so that traffic reaches the service over AWS PrivateLink rather than the public internet.

Example Usage

import { PrivateLinkEndpoint } from "@vercel/sdk/models/privatelinkendpoint.js";

let value: PrivateLinkEndpoint = {
  awsDnsEntries: [
    "vpce-0123456789abcdef0-a1b2c3d4.vpce-svc-0123456789abcdef0.us-east-1.vpce.amazonaws.com",
  ],
  awsServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0",
  createdAt: 1610963878358,
  endpointId: "ple_a1b2c3d4e5f6g7h8",
  name: "payments-db",
  privateDnsNames: [
    "payments.internal.example.com",
  ],
  projectId: "prj_a1b2c3d4e5f6g7h8",
  status: "available",
  statusMessage:
    "Endpoint did not become available in time. Try deleting and recreating, or visit https://vercel.com/help if the issue persists.",
  teamId: "team_a1b2c3d4e5f6g7h8",
  updatedAt: 1610963878358,
  vercelRegion: "iad1",
  vpcEndpointId: "vpce-0123456789abcdef0",
};

Fields

Field	Type	Required	Description	Example
awsDnsEntries	string[]	➖	The regional DNS names assigned to the endpoint by AWS. Use these to reach the service when private DNS is not enabled.	[ "vpce-0123456789abcdef0-a1b2c3d4.vpce-svc-0123456789abcdef0.us-east-1.vpce.amazonaws.com" ]
awsServiceName	string	✔️	The AWS VPC endpoint service the endpoint connects to.	com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0
createdAt	number	✔️	Timestamp in milliseconds since the UNIX epoch for when the endpoint was created.	1610963878358
endpointId	string	✔️	The unique identifier of the PrivateLink endpoint.	ple_a1b2c3d4e5f6g7h8
name	string	✔️	The name of the PrivateLink endpoint, shown in the Vercel dashboard.	payments-db
privateDnsNames	string[]	➖	The private DNS names of the endpoint service, populated when private DNS is enabled for the endpoint.	[ "payments.internal.example.com" ]
projectId	string	✔️	The identifier of the project the PrivateLink endpoint belongs to.	prj_a1b2c3d4e5f6g7h8
status	models.PrivateLinkEndpointStatus	✔️	The current state of the endpoint. - creating: the endpoint is being created. - pending-acceptance: waiting for the endpoint service owner to accept the connection. Only occurs for services that require manual acceptance. - provisioning: the connection was accepted and AWS is finishing setup. - available: the endpoint is fully provisioned and ready to use. - rejected: the endpoint service owner rejected the connection. - failed: the endpoint could not be provisioned. - deleting: the endpoint is being deleted.	available
statusMessage	string	➖	A human-readable explanation of why the endpoint could not be provisioned. Only set when status is failed, and absent for every other status including rejected, since AWS does not report a rejection reason.	Endpoint did not become available in time. Try deleting and recreating, or visit https://vercel.com/help if the issue persists.
teamId	string	✔️	The identifier of the team that owns the PrivateLink endpoint.	team_a1b2c3d4e5f6g7h8
updatedAt	number	✔️	Timestamp in milliseconds since the UNIX epoch for when the endpoint was last updated.	1610963878358
vercelRegion	string	✔️	The Vercel region the endpoint is provisioned in.	iad1
vpcEndpointId	string	➖	The identifier of the underlying AWS VPC endpoint. Absent until AWS has created the endpoint.	vpce-0123456789abcdef0