Skip to content

VpcLink

Source code in docs_src/capo_api_gateway/types/vpc_link.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class VpcLink(TypedDict, closed=True):
    id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>"""
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name used to label and identify the VPC link.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the VPC link.</p>"""
    target_arns: NotRequired["capo_api_gateway.types.list_of_string.ListOfString"]
    """<p>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.</p>"""
    status: NotRequired["capo_api_gateway.types.vpc_link_status.VpcLinkStatus"]
    """<p>The status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>. </p>"""
    status_message: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A description about the VPC link status.</p>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The collection of tags. Each tag element is associated with a given resource.</p>"""

description instance-attribute 

description: NotRequired[String]

The description of the VPC link.

id instance-attribute 

id: NotRequired[String]

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

name instance-attribute 

name: NotRequired[String]

The name used to label and identify the VPC link.

status instance-attribute 

status: NotRequired[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.

status_message instance-attribute 

status_message: NotRequired[String]

A description about the VPC link status.

tags instance-attribute 

tags: NotRequired[MapOfStringToString]

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

target_arns instance-attribute 

target_arns: NotRequired[ListOfString]

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.