Skip to main content

privatelink_endpoints

Creates, updates, deletes, gets or lists a privatelink_endpoints resource.

Overview​

Nameprivatelink_endpoints
TypeResource
Idvercel.networking.privatelink_endpoints

Fields​

The following fields are returned by SELECT queries:

The requested PrivateLink endpoint.

NameDatatypeDescription
namestringThe name of the PrivateLink endpoint, shown in the Vercel dashboard. (example: payments-db)
endpoint_idstringThe unique identifier of the PrivateLink endpoint. (example: ple_a1b2c3d4e5f6g7h8) (wire: endpointId)
project_idstringThe identifier of the project the PrivateLink endpoint belongs to. (example: prj_a1b2c3d4e5f6g7h8) (wire: projectId)
team_idstringThe identifier of the team that owns the PrivateLink endpoint. (example: team_a1b2c3d4e5f6g7h8) (wire: teamId)
vpc_endpoint_idstringThe identifier of the underlying AWS VPC endpoint. Absent until AWS has created the endpoint. (example: vpce-0123456789abcdef0) (wire: vpcEndpointId)
aws_service_namestringThe AWS VPC endpoint service the endpoint connects to. (example: com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0) (wire: awsServiceName)
aws_dns_entriesarrayThe regional DNS names assigned to the endpoint by AWS. Use these to reach the service when private DNS is not enabled. (wire: awsDnsEntries)
created_atnumberTimestamp in milliseconds since the UNIX epoch for when the endpoint was created. (wire: createdAt)
private_dns_namesarrayThe private DNS names of the endpoint service, populated when private DNS is enabled for the endpoint. (wire: privateDnsNames)
statusstringThe 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, creating, deleting, failed, pending-acceptance, provisioning, rejected) (example: available)
status_messagestringA 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. (example: Endpoint did not become available in time. Try deleting and recreating, or visit https:​//vercel.com/help if the issue persists.) (wire: statusMessage)
updated_atnumberTimestamp in milliseconds since the UNIX epoch for when the endpoint was last updated. (wire: updatedAt)
vercel_regionstringThe Vercel region the endpoint is provisioned in. (example: iad1) (wire: vercelRegion)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject_id, endpoint_idteam_id, slugReads a single PrivateLink endpoint.
listselectproject_idteam_id, slugLists all PrivateLink endpoints for a project.
createinsertproject_id, name, vercel_region, aws_service_nameteam_id, slugCreates a PrivateLink endpoint for a project.
updateupdateproject_id, endpoint_idteam_id, slugUpdates a PrivateLink endpoint (name, privateDns).
deletedeleteproject_id, endpoint_idteam_id, slugDeletes a PrivateLink endpoint.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpoint_idstringThe unique identifier of the PrivateLink endpoint.
project_idstringThe project ID the PrivateLink endpoint belongs to. (wire: projectId)
slugstringThe Team slug to perform the request on behalf of.
team_idstringThe Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples​

Reads a single PrivateLink endpoint.

SELECT
name,
endpoint_id,
project_id,
team_id,
vpc_endpoint_id,
aws_service_name,
aws_dns_entries,
created_at,
private_dns_names,
status,
status_message,
updated_at,
vercel_region
FROM vercel.networking.privatelink_endpoints
WHERE project_id = '{{ project_id }}' -- required
AND endpoint_id = '{{ endpoint_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples​

Creates a PrivateLink endpoint for a project.

INSERT INTO vercel.networking.privatelink_endpoints (
project_id,
name,
vercel_region,
aws_service_name,
enable_private_dns,
team_id,
slug
)
SELECT 
'{{ project_id }}' /* required */,
'{{ name }}' /* required */,
'{{ vercel_region }}' /* required */,
'{{ aws_service_name }}' /* required */,
{{ enable_private_dns }},
'{{ team_id }}',
'{{ slug }}'
RETURNING
name,
endpoint_id,
project_id,
team_id,
vpc_endpoint_id,
aws_service_name,
aws_dns_entries,
created_at,
private_dns_names,
status,
status_message,
updated_at,
vercel_region
;

UPDATE examples​

Updates a PrivateLink endpoint (name, privateDns).

UPDATE vercel.networking.privatelink_endpoints
SET 
name = '{{ name }}',
enable_private_dns = {{ enable_private_dns }}
WHERE 
project_id = '{{ project_id }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}'
RETURNING
name,
endpoint_id,
project_id,
team_id,
vpc_endpoint_id,
aws_service_name,
aws_dns_entries,
created_at,
private_dns_names,
status,
status_message,
updated_at,
vercel_region;

DELETE examples​

Deletes a PrivateLink endpoint.

DELETE FROM vercel.networking.privatelink_endpoints
WHERE project_id = '{{ project_id }}' --required
AND endpoint_id = '{{ endpoint_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;
Last updated on