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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::VpcLink

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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>

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the VPC link.

• #id ⇒ String

  The identifier of the VpcLink.

• #name ⇒ String

  The name used to label and identify the VPC link.

• #status ⇒ String

  The status of the VPC link.

• #status_message ⇒ String

  A description about the VPC link status.

• #tags ⇒ Hash<String,String>

  The collection of tags.

• #target_arns ⇒ Array<String>

  The ARN of the network load balancer of the VPC targeted by the VPC link.

Instance Attribute Details

#description ⇒ String

The description of the VPC link.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#name ⇒ String

The name used to label and identify the VPC link.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#status ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#status_message ⇒ String

A description about the VPC link status.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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

#target_arns ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 8302

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