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

Inherits:
Struct
  • Object
show all
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).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the VPC link.

Returns:

  • (String)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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 Amazon Web Services account of the API owner.

Returns:

  • (Array<String>)


5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'lib/aws-sdk-apigateway/types.rb', line 5980

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