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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

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.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end

#nameString

The name used to label and identify the VPC link.

Returns:

  • (String)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end

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

Returns:

  • (String)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end

#status_messageString

A description about the VPC link status.

Returns:

  • (String)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end

#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>)


7658
7659
7660
7661
7662
7663
7664
7665
7666
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7658

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message)
  include Aws::Structure
end