Class: AWSCDK::ElasticLoadBalancing::LoadBalancer

Inherits:
Resource
  • Object
show all
Includes:
AWSCDK::EC2::IConnectable, ILoadBalancer
Defined in:
elastic_load_balancing/load_balancer.rb

Overview

A load balancer with a single listener.

Routes to a fleet of instances in a VPC.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ LoadBalancer

Returns a new instance of LoadBalancer.

Parameters:



15
16
17
18
19
20
21
 
# File 'elastic_load_balancing/load_balancer.rb', line 15

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::LoadBalancerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmcuTG9hZEJhbGFuY2VyUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'elastic_load_balancing/load_balancer.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :listener_ports => { kind: :property, name: "listenerPorts", is_optional: false },
    :load_balancer_canonical_hosted_zone_name => { kind: :property, name: "loadBalancerCanonicalHostedZoneName", is_optional: false },
    :load_balancer_canonical_hosted_zone_name_id => { kind: :property, name: "loadBalancerCanonicalHostedZoneNameId", is_optional: false },
    :load_balancer_dns_name => { kind: :property, name: "loadBalancerDnsName", is_optional: false },
    :load_balancer_name => { kind: :property, name: "loadBalancerName", is_optional: false },
    :load_balancer_ref => { kind: :property, name: "loadBalancerRef", is_optional: false },
    :load_balancer_source_security_group_group_name => { kind: :property, name: "loadBalancerSourceSecurityGroupGroupName", is_optional: false },
    :load_balancer_source_security_group_owner_alias => { kind: :property, name: "loadBalancerSourceSecurityGroupOwnerAlias", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_listener => { kind: :method, name: "addListener", is_optional: false },
    :add_target => { kind: :method, name: "addTarget", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


96
97
98
 
# File 'elastic_load_balancing/load_balancer.rb', line 96

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticloadbalancing.LoadBalancer", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_listener(listener) ⇒ AWSCDK::ElasticLoadBalancing::ListenerPort

Add a backend to the load balancer.

Parameters:

Returns:



245
246
247
248
249
 
# File 'elastic_load_balancing/load_balancer.rb', line 245

def add_listener(listener)
  listener = listener.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancing::LoadBalancerListener.new(**listener.transform_keys(&:to_sym)) : listener
  Jsii::Type.check_type(listener, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmcuTG9hZEJhbGFuY2VyTGlzdGVuZXIifQ==")), "listener")
  jsii_call_method("addListener", [listener])
end

#add_target(target) ⇒ void

This method returns an undefined value.

Parameters:



253
254
255
256
 
# File 'elastic_load_balancing/load_balancer.rb', line 253

def add_target(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmcuSUxvYWRCYWxhbmNlclRhcmdldCJ9")), "target")
  jsii_call_method("addTarget", [target])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



184
185
186
187
 
# File 'elastic_load_balancing/load_balancer.rb', line 184

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



201
202
203
204
 
# File 'elastic_load_balancing/load_balancer.rb', line 201

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#connections ⇒ AWSCDK::EC2::Connections

Control all connections from and to this load balancer.

Returns:



103
104
105
 
# File 'elastic_load_balancing/load_balancer.rb', line 103

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



68
69
70
 
# File 'elastic_load_balancing/load_balancer.rb', line 68

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


207
208
209
 
# File 'elastic_load_balancing/load_balancer.rb', line 207

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


221
222
223
224
225
226
 
# File 'elastic_load_balancing/load_balancer.rb', line 221

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


236
237
238
239
 
# File 'elastic_load_balancing/load_balancer.rb', line 236

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#listener_ports ⇒ Array<AWSCDK::ElasticLoadBalancing::ListenerPort>

An object controlling specifically the connections for each listener added to this load balancer.

Returns:



110
111
112
 
# File 'elastic_load_balancing/load_balancer.rb', line 110

def listener_ports()
  jsii_get_property("listenerPorts")
end

#load_balancer_canonical_hosted_zone_name ⇒ String

Returns:

  • (String) 


115
116
117
 
# File 'elastic_load_balancing/load_balancer.rb', line 115

def load_balancer_canonical_hosted_zone_name()
  jsii_get_property("loadBalancerCanonicalHostedZoneName")
end

#load_balancer_canonical_hosted_zone_name_id ⇒ String

Returns:

  • (String) 


120
121
122
 
# File 'elastic_load_balancing/load_balancer.rb', line 120

def load_balancer_canonical_hosted_zone_name_id()
  jsii_get_property("loadBalancerCanonicalHostedZoneNameId")
end

#load_balancer_dns_name ⇒ String

Returns:

  • (String) 


125
126
127
 
# File 'elastic_load_balancing/load_balancer.rb', line 125

def load_balancer_dns_name()
  jsii_get_property("loadBalancerDnsName")
end

#load_balancer_name ⇒ String

Returns:

  • (String) 


130
131
132
 
# File 'elastic_load_balancing/load_balancer.rb', line 130

def load_balancer_name()
  jsii_get_property("loadBalancerName")
end

#load_balancer_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancing::LoadBalancerReference

A reference to this LoadBalancer resource.

Returns:



137
138
139
 
# File 'elastic_load_balancing/load_balancer.rb', line 137

def load_balancer_ref()
  jsii_get_property("loadBalancerRef")
end

#load_balancer_source_security_group_group_name ⇒ String

Returns:

  • (String) 


142
143
144
 
# File 'elastic_load_balancing/load_balancer.rb', line 142

def load_balancer_source_security_group_group_name()
  jsii_get_property("loadBalancerSourceSecurityGroupGroupName")
end

#load_balancer_source_security_group_owner_alias ⇒ String

Returns:

  • (String) 


147
148
149
 
# File 'elastic_load_balancing/load_balancer.rb', line 147

def load_balancer_source_security_group_owner_alias()
  jsii_get_property("loadBalancerSourceSecurityGroupOwnerAlias")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


53
54
55
 
# File 'elastic_load_balancing/load_balancer.rb', line 53

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


82
83
84
 
# File 'elastic_load_balancing/load_balancer.rb', line 82

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



89
90
91
 
# File 'elastic_load_balancing/load_balancer.rb', line 89

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


154
155
156
 
# File 'elastic_load_balancing/load_balancer.rb', line 154

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


167
168
169
170
171
172
 
# File 'elastic_load_balancing/load_balancer.rb', line 167

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end