AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy


Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z


public class VpcLink

The VpcLink type exposes the following members


Public Method VpcLink()


Public Property Description System.String

Gets and sets the property Description.

The description of the VPC link.

Public Property Id System.String

Gets and sets the property Id.

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

Public Property Name System.String

Gets and sets the property Name.

The name used to label and identify the VPC link.

Public Property Status Amazon.APIGateway.VpcLinkStatus

Gets and sets the property Status.

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.

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

A description about the VPC link status.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Public Property TargetArns System.Collections.Generic.List<System.String>

Gets and sets the property TargetArns.

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.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms