Skip to content

Api Gateway  >  Structures  >  VpcLink

VpcLink

Structure Class

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

description class-attribute instance-attribute 
description: str | None = None

The description of the VPC link.

id class-attribute instance-attribute 
id: str | None = None

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

name class-attribute instance-attribute 
name: str | None = None

The name used to label and identify the VPC link.

status class-attribute instance-attribute 
status: VpcLinkStatus | None = None

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.

status_message class-attribute instance-attribute 
status_message: str | None = None

A description about the VPC link status.

tags class-attribute instance-attribute 
tags: dict[str, str] | None = None

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

target_arns class-attribute instance-attribute 
target_arns: list[str] | None = None

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.