VpcLink

import type { VpcLink } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

An API Gateway VPC link for a "RestApi" to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a "VpcLink" resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the "VpcLink". The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the "VpcLink" used.

interface VpcLink {

description?: string | null;

id?: string | null;

name?: string | null;

status?: VpcLinkStatus | null;

statusMessage?: string | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

targetArns?: string[] | null;

}

§Properties

description?: string | null

[src]

The description of the VPC link.

id?: string | null

[src]

The identifier of the "VpcLink". It is used in an "Integration" to reference this "VpcLink".

name?: string | null

[src]

The name used to label and identify the VPC link.

status?: VpcLinkStatus | null

[src]

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

statusMessage?: string | null

[src]

A description about the VPC link status.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

The collection of tags. Each tag element is associated with a given resource.

targetArns?: string[] | null

[src]

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.