VpcLink - Amazon API Gateway
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

VpcLink

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

The description of the VPC link.

Type: String

Required: No

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

Type: String

Required: No

The name used to label and identify the VPC link.

Type: String

Required: No

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.

Type: String

Valid Values: AVAILABLE | PENDING | DELETING | FAILED

Required: No

A description about the VPC link status.

Type: String

Required: No

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

Type: String to string map

Required: No

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 Amazon Web Services account of the API owner.

Type: Array of strings

Required: No

For more information about using this API in one of the language-specific Amazon SDKs, see the following: