class Amazonite::ApiGateway::VpcLink

Overview

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

Included Modules

Defined in:

api_gateway/vpc_link.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def description : String | Nil #

The description of the VPC link.


[View source]
def description=(description : String | Nil) #

The description of the VPC link.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def id : String | Nil #

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


[View source]
def id=(id : String | Nil) #

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


[View source]
def name : String | Nil #

The name used to label and identify the VPC link.


[View source]
def name=(name : String | Nil) #

The name used to label and identify the VPC link.


[View source]
def status : VpcLinkStatus | Nil #

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.


[View source]
def status=(status : VpcLinkStatus | Nil) #

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.


[View source]
def status_message : String | Nil #

A description about the VPC link status.


[View source]
def status_message=(status_message : String | Nil) #

A description about the VPC link status.


[View source]
def tags : Hash(String, String) | Nil #

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


[View source]
def tags=(tags : Hash(String, String) | Nil) #

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


[View source]
def target_arns : Array(String) | Nil #

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.


[View source]
def target_arns=(target_arns : Array(String) | Nil) #

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.


[View source]
def validate! : Nil #

[View source]