VpcLink class

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.

Constructors

VpcLink.fromJson(Map<String, dynamic> json)
factory

Properties

description → String?
The description of the VPC link.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
final
name → String?
The name used to label and identify the VPC link.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → VpcLinkStatus?
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.
final
statusMessage → String?
A description about the VPC link status.
final
tags → Map<String, String>?
The collection of tags. Each tag element is associated with a given resource.
final
targetArns → List<String>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited