Class: AWSCDK::APIGateway::VPCLinkProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/vpc_link_props.rb

Overview

Properties for a VpcLink.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, targets: nil, vpc_link_name: nil) ⇒ VPCLinkProps

Returns a new instance of VPCLinkProps.

Parameters:

  • description (String, nil) (defaults to: nil) —

    The description of the VPC link.

  • targets (Array<AWSCDK::ElasticLoadBalancingv2::INetworkLoadBalancer>, nil) (defaults to: nil) —

    The network load balancers of the VPC targeted by the VPC link.

  • vpc_link_name (String, nil) (defaults to: nil) —

    The name used to label and identify the VPC link.



10
11
12
13
14
15
16
17
 
# File 'api_gateway/vpc_link_props.rb', line 10

def initialize(description: nil, targets: nil, vpc_link_name: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @targets = targets
  Jsii::Type.check_type(@targets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljbG9hZGJhbGFuY2luZ3YyLklOZXR3b3JrTG9hZEJhbGFuY2VyIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "targets") unless @targets.nil?
  @vpc_link_name = vpc_link_name
  Jsii::Type.check_type(@vpc_link_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcLinkName") unless @vpc_link_name.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: no description

The description of the VPC link.

Returns:

  • (String, nil) 


23
24
25
 
# File 'api_gateway/vpc_link_props.rb', line 23

def description
  @description
end

#targets ⇒ Array<AWSCDK::ElasticLoadBalancingv2::INetworkLoadBalancer>? (readonly)

Note:

Default: - no targets. Use addTargets to add targets

The network load balancers of the VPC targeted by the VPC link.

The network load balancers must be owned by the same AWS account of the API owner.

Returns:



30
31
32
 
# File 'api_gateway/vpc_link_props.rb', line 30

def targets
  @targets
end

#vpc_link_name ⇒ String? (readonly)

Note:

Default: - automatically generated name

The name used to label and identify the VPC link.

Returns:

  • (String, nil) 


35
36
37
 
# File 'api_gateway/vpc_link_props.rb', line 35

def vpc_link_name
  @vpc_link_name
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'api_gateway/vpc_link_props.rb', line 37

def self.jsii_properties
  {
    :description => "description",
    :targets => "targets",
    :vpc_link_name => "vpcLinkName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'api_gateway/vpc_link_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "targets" => @targets,
    "vpcLinkName" => @vpc_link_name,
  })
  result.compact
end