You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::VpcLink

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)

    The description of the VPC link.

#idString

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

Returns:

  • (String)

    The identifier of the VpcLink.

#nameString

The name used to label and identify the VPC link.

Returns:

  • (String)

    The name used to label and identify the VPC link.

#statusString

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.

Possible values:

  • AVAILABLE
  • PENDING
  • DELETING
  • FAILED

Returns:

  • (String)

    The status of the VPC link.

#status_messageString

A description about the VPC link status.

Returns:

  • (String)

    A description about the VPC link status.

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

    The collection of tags.

#target_arnsArray<String>

The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Returns:

  • (Array<String>)

    The ARNs of network load balancers of the VPC targeted by the VPC link.