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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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)


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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)


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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)


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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)


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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


7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7481

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