Class: AWSCDK::ElasticLoadBalancingv2::NetworkLoadBalancerAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elastic_load_balancingv2/network_load_balancer_attributes.rb

Overview

Properties to reference an existing load balancer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(load_balancer_arn:, load_balancer_canonical_hosted_zone_id: nil, load_balancer_dns_name: nil, load_balancer_security_groups: nil, vpc: nil) ⇒ NetworkLoadBalancerAttributes

Returns a new instance of NetworkLoadBalancerAttributes.

Parameters:

  • load_balancer_arn (String) —

    ARN of the load balancer.

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

    The canonical hosted zone ID of this load balancer.

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

    The DNS name of this load balancer.

  • load_balancer_security_groups (Array<String>, nil) (defaults to: nil) —

    Security groups to associate with this load balancer.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC to associate with the load balancer.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 12

def initialize(load_balancer_arn:, load_balancer_canonical_hosted_zone_id: nil, load_balancer_dns_name: nil, load_balancer_security_groups: nil, vpc: nil)
  @load_balancer_arn = load_balancer_arn
  Jsii::Type.check_type(@load_balancer_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerArn")
  @load_balancer_canonical_hosted_zone_id = load_balancer_canonical_hosted_zone_id
  Jsii::Type.check_type(@load_balancer_canonical_hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerCanonicalHostedZoneId") unless @load_balancer_canonical_hosted_zone_id.nil?
  @load_balancer_dns_name = load_balancer_dns_name
  Jsii::Type.check_type(@load_balancer_dns_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerDnsName") unless @load_balancer_dns_name.nil?
  @load_balancer_security_groups = load_balancer_security_groups
  Jsii::Type.check_type(@load_balancer_security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "loadBalancerSecurityGroups") unless @load_balancer_security_groups.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
end

Instance Attribute Details

#load_balancer_arn ⇒ String (readonly)

ARN of the load balancer.

Returns:

  • (String) 


28
29
30
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 28

def load_balancer_arn
  @load_balancer_arn
end

#load_balancer_canonical_hosted_zone_id ⇒ String? (readonly)

Note:

Default: - When not provided, LB cannot be used as Route53 Alias target.

The canonical hosted zone ID of this load balancer.

Returns:

  • (String, nil) 


33
34
35
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 33

def load_balancer_canonical_hosted_zone_id
  @load_balancer_canonical_hosted_zone_id
end

#load_balancer_dns_name ⇒ String? (readonly)

Note:

Default: - When not provided, LB cannot be used as Route53 Alias target.

The DNS name of this load balancer.

Returns:

  • (String, nil) 


38
39
40
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 38

def load_balancer_dns_name
  @load_balancer_dns_name
end

#load_balancer_security_groups ⇒ Array<String>? (readonly)

Note:

Default: - No security groups associated with the load balancer.

Security groups to associate with this load balancer.

Returns:

  • (Array<String>, nil) 


43
44
45
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 43

def load_balancer_security_groups
  @load_balancer_security_groups
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - When not provided, listeners cannot be created on imported load balancers.

The VPC to associate with the load balancer.

Returns:



48
49
50
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 48

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 50

def self.jsii_properties
  {
    :load_balancer_arn => "loadBalancerArn",
    :load_balancer_canonical_hosted_zone_id => "loadBalancerCanonicalHostedZoneId",
    :load_balancer_dns_name => "loadBalancerDnsName",
    :load_balancer_security_groups => "loadBalancerSecurityGroups",
    :vpc => "vpc",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'elastic_load_balancingv2/network_load_balancer_attributes.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "loadBalancerArn" => @load_balancer_arn,
    "loadBalancerCanonicalHostedZoneId" => @load_balancer_canonical_hosted_zone_id,
    "loadBalancerDnsName" => @load_balancer_dns_name,
    "loadBalancerSecurityGroups" => @load_balancer_security_groups,
    "vpc" => @vpc,
  })
  result.compact
end