@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
83 lines • 4.65 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
/**
* 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.
*/
export declare const PrivateLinkEndpointStatus: {
readonly Available: "available";
readonly Creating: "creating";
readonly Deleting: "deleting";
readonly Failed: "failed";
readonly PendingAcceptance: "pending-acceptance";
readonly Provisioning: "provisioning";
readonly Rejected: "rejected";
};
/**
* 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.
*/
export type PrivateLinkEndpointStatus = ClosedEnum<typeof PrivateLinkEndpointStatus>;
/**
* 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.
*/
export type PrivateLinkEndpoint = {
/**
* The unique identifier of the PrivateLink endpoint.
*/
endpointId: string;
/**
* The name of the PrivateLink endpoint, shown in the Vercel dashboard.
*/
name: string;
/**
* The identifier of the team that owns the PrivateLink endpoint.
*/
teamId: string;
/**
* The identifier of the project the PrivateLink endpoint belongs to.
*/
projectId: string;
/**
* The Vercel region the endpoint is provisioned in.
*/
vercelRegion: string;
/**
* The AWS VPC endpoint service the endpoint connects to.
*/
awsServiceName: string;
/**
* The identifier of the underlying AWS VPC endpoint. Absent until AWS has created the endpoint.
*/
vpcEndpointId?: string | undefined;
/**
* The regional DNS names assigned to the endpoint by AWS. Use these to reach the service when private DNS is not enabled.
*/
awsDnsEntries?: Array<string> | undefined;
/**
* The private DNS names of the endpoint service, populated when private DNS is enabled for the endpoint.
*/
privateDnsNames?: Array<string> | undefined;
/**
* 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.
*/
status: PrivateLinkEndpointStatus;
/**
* 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.
*/
statusMessage?: string | undefined;
/**
* Timestamp in milliseconds since the UNIX epoch for when the endpoint was created.
*/
createdAt: number;
/**
* Timestamp in milliseconds since the UNIX epoch for when the endpoint was last updated.
*/
updatedAt: number;
};
/** @internal */
export declare const PrivateLinkEndpointStatus$inboundSchema: z.ZodNativeEnum<typeof PrivateLinkEndpointStatus>;
/** @internal */
export declare const PrivateLinkEndpoint$inboundSchema: z.ZodType<PrivateLinkEndpoint, z.ZodTypeDef, unknown>;
export declare function privateLinkEndpointFromJSON(jsonString: string): SafeParseResult<PrivateLinkEndpoint, SDKValidationError>;
//# sourceMappingURL=privatelinkendpoint.d.ts.map