class Aws::APIGateway::Types::VpcLink

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

<div class=“remarks” markdown=“1”> 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.

</div>

@!attribute [rw] id

The identifier of the VpcLink. It is used in an Integration to
reference this VpcLink.
@return [String]

@!attribute [rw] name

The name used to label and identify the VPC link.
@return [String]

@!attribute [rw] description

The description of the VPC link.
@return [String]

@!attribute [rw] target_arns

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.
@return [Array<String>]

@!attribute [rw] 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`.
@return [String]

@!attribute [rw] status_message

A description about the VPC link status.
@return [String]

@!attribute [rw] tags

The collection of tags. Each tag element is associated with a given
resource.
@return [Hash<String,String>]

Constants

SENSITIVE