create_vpc_link¶
Operation¶
async
¶
create_vpc_link(input: CreateVpcLinkInput, plugins: list[Plugin] | None = None) -> CreateVpcLinkOutput
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateVpcLinkInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateVpcLinkOutput
|
An instance of |
Input¶
dataclass
¶
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = None
The description of the VPC link.
class-attribute
instance-attribute
¶
name: str | None = None
The name used to label and identify the VPC link.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
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.
Output¶
dataclass
¶
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = None
The description of the VPC link.
class-attribute
instance-attribute
¶
id: str | None = None
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
class-attribute
instance-attribute
¶
name: str | None = None
The name used to label and identify the VPC link.
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.
class-attribute
instance-attribute
¶
status_message: str | None = None
A description about the VPC link status.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The collection of tags. Each tag element is associated with a given resource.
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.