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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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).

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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

#idString

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

Returns:

  • (String)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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

#nameString

The name used to label and identify the VPC link.

Returns:

  • (String)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

class VpcLink < Struct.new(
  :id,
  :name,
  :description,
  :target_arns,
  :status,
  :status_message,
  :tags)
  SENSITIVE = []
  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)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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

#status_messageString

A description about the VPC link status.

Returns:

  • (String)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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

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


8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8297

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