Class: AWSCDK::ElasticLoadBalancingv2::ApplicationLoadBalancerAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elastic_load_balancingv2/application_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:, security_group_id:, load_balancer_canonical_hosted_zone_id: nil, load_balancer_dns_name: nil, security_group_allows_all_outbound: nil, vpc: nil) ⇒ ApplicationLoadBalancerAttributes

Returns a new instance of ApplicationLoadBalancerAttributes.

Parameters:

  • load_balancer_arn (String) —

    ARN of the load balancer.

  • security_group_id (String) —

    ID of the load balancer's security group.

  • 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.

  • security_group_allows_all_outbound (Boolean, nil) (defaults to: nil) —

    Whether the security group allows all outbound traffic or not.

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

    The VPC this load balancer has been created in, if available.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 13

def initialize(load_balancer_arn:, security_group_id:, load_balancer_canonical_hosted_zone_id: nil, load_balancer_dns_name: nil, security_group_allows_all_outbound: nil, vpc: nil)
  @load_balancer_arn = load_balancer_arn
  Jsii::Type.check_type(@load_balancer_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadBalancerArn")
  @security_group_id = security_group_id
  Jsii::Type.check_type(@security_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityGroupId")
  @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?
  @security_group_allows_all_outbound = security_group_allows_all_outbound
  Jsii::Type.check_type(@security_group_allows_all_outbound, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "securityGroupAllowsAllOutbound") unless @security_group_allows_all_outbound.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) 


31
32
33
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 31

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) 


40
41
42
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 40

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) 


45
46
47
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 45

def load_balancer_dns_name
  @load_balancer_dns_name
end

#security_group_allows_all_outbound ⇒ Boolean? (readonly)

Note:

Default: true

Whether the security group allows all outbound traffic or not.

Unless set to false, no egress rules will be added to the security group.

Returns:

  • (Boolean, nil) 


52
53
54
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 52

def security_group_allows_all_outbound
  @security_group_allows_all_outbound
end

#security_group_id ⇒ String (readonly)

ID of the load balancer's security group.

Returns:

  • (String) 


35
36
37
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 35

def security_group_id
  @security_group_id
end

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

Note:

Default: - If the Load Balancer was imported and a VPC was not specified, the VPC is not available.

The VPC this load balancer has been created in, if available.

Returns:



57
58
59
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 57

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 59

def self.jsii_properties
  {
    :load_balancer_arn => "loadBalancerArn",
    :security_group_id => "securityGroupId",
    :load_balancer_canonical_hosted_zone_id => "loadBalancerCanonicalHostedZoneId",
    :load_balancer_dns_name => "loadBalancerDnsName",
    :security_group_allows_all_outbound => "securityGroupAllowsAllOutbound",
    :vpc => "vpc",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'elastic_load_balancingv2/application_load_balancer_attributes.rb', line 70

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