class
Amazonite::ApiGateway::VpcLink
- Amazonite::ApiGateway::VpcLink
- Reference
- Object
Overview
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Included Modules
- JSON::Serializable
Defined in:
api_gateway/vpc_link.crConstructors
- .new(pull : JSON::PullParser)
- .new(id : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, target_arns : Array(String) | Nil = nil, status : VpcLinkStatus | Nil = nil, status_message : String | Nil = nil, tags : Hash(String, String) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#description : String | Nil
The description of the VPC link.
-
#description=(description : String | Nil)
The description of the VPC link.
-
#hash(hasher)
See
Object#hash(hasher) -
#id : String | Nil
The identifier of the VpcLink.
-
#id=(id : String | Nil)
The identifier of the VpcLink.
-
#name : String | Nil
The name used to label and identify the VPC link.
-
#name=(name : String | Nil)
The name used to label and identify the VPC link.
-
#status : VpcLinkStatus | Nil
The status of the VPC link.
-
#status=(status : VpcLinkStatus | Nil)
The status of the VPC link.
-
#status_message : String | Nil
A description about the VPC link status.
-
#status_message=(status_message : String | Nil)
A description about the VPC link status.
-
#tags : Hash(String, String) | Nil
The collection of tags.
-
#tags=(tags : Hash(String, String) | Nil)
The collection of tags.
-
#target_arns : Array(String) | Nil
The ARN of the network load balancer of the VPC targeted by the VPC link.
-
#target_arns=(target_arns : Array(String) | Nil)
The ARN of the network load balancer of the VPC targeted by the VPC link.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
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.
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.
The collection of tags. Each tag element is associated with a given resource.
The collection of tags. Each tag element is associated with a given resource.
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.
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.