Class: AWSCDK::ElasticLoadBalancingv2::ApplicationTargetGroup

Inherits:
TargetGroupBase
  • Object
show all
Includes:
IApplicationTargetGroup
Defined in:
elastic_load_balancingv2/application_target_group.rb

Overview

Define an Application Target Group.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ ApplicationTargetGroup

Returns a new instance of ApplicationTargetGroup.

Parameters:



12
13
14
15
16
17
18
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::ApplicationTargetGroupProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5BcHBsaWNhdGlvblRhcmdldEdyb3VwUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_target_group_attributes(scope, id, attrs) ⇒ AWSCDK::ElasticLoadBalancingv2::IApplicationTargetGroup

Import an existing target group.

Parameters:

Returns:



67
68
69
70
71
72
73
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 67

def self.from_target_group_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::TargetGroupAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5UYXJnZXRHcm91cEF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup", "fromTargetGroupAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
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
49
50
51
52
53
54
55
56
57
58
59
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :default_port => { kind: :property, name: "defaultPort", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :first_load_balancer_full_name => { kind: :property, name: "firstLoadBalancerFullName", is_optional: false },
    :load_balancer_arns => { kind: :property, name: "loadBalancerArns", is_optional: false },
    :load_balancer_attached => { kind: :property, name: "loadBalancerAttached", is_optional: false },
    :load_balancer_attached_dependencies => { kind: :property, name: "loadBalancerAttachedDependencies", is_optional: false },
    :target_group_arn => { kind: :property, name: "targetGroupArn", is_optional: false },
    :target_group_full_name => { kind: :property, name: "targetGroupFullName", is_optional: false },
    :target_group_load_balancer_arns => { kind: :property, name: "targetGroupLoadBalancerArns", is_optional: false },
    :target_group_name => { kind: :property, name: "targetGroupName", is_optional: false },
    :target_group_ref => { kind: :property, name: "targetGroupRef", is_optional: false },
    :health_check => { kind: :property, name: "healthCheck", is_optional: false },
    :target_type => { kind: :property, name: "targetType", is_optional: true },
    :metrics => { kind: :property, name: "metrics", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_load_balancer_target => { kind: :method, name: "addLoadBalancerTarget", is_optional: false },
    :configure_health_check => { kind: :method, name: "configureHealthCheck", is_optional: false },
    :set_attribute => { kind: :method, name: "setAttribute", is_optional: false },
    :validate_health_check => { kind: :method, name: "validateHealthCheck", is_optional: false },
    :validate_target_group => { kind: :method, name: "validateTargetGroup", is_optional: false },
    :add_target => { kind: :method, name: "addTarget", is_optional: false },
    :enable_cookie_stickiness => { kind: :method, name: "enableCookieStickiness", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_healthy_host_count => { kind: :method, name: "metricHealthyHostCount", is_optional: false },
    :metric_http_code_target => { kind: :method, name: "metricHttpCodeTarget", is_optional: false },
    :metric_ipv6_request_count => { kind: :method, name: "metricIpv6RequestCount", is_optional: false },
    :metric_request_count => { kind: :method, name: "metricRequestCount", is_optional: false },
    :metric_request_count_per_target => { kind: :method, name: "metricRequestCountPerTarget", is_optional: false },
    :metric_target_connection_error_count => { kind: :method, name: "metricTargetConnectionErrorCount", is_optional: false },
    :metric_target_response_time => { kind: :method, name: "metricTargetResponseTime", is_optional: false },
    :metric_target_tls_negotiation_error_count => { kind: :method, name: "metricTargetTLSNegotiationErrorCount", is_optional: false },
    :metric_unhealthy_host_count => { kind: :method, name: "metricUnhealthyHostCount", is_optional: false },
    :register_connectable => { kind: :method, name: "registerConnectable", is_optional: false },
    :register_listener => { kind: :method, name: "registerListener", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


187
188
189
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 187

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

Instance Method Details

#add_load_balancer_target(props) ⇒ void

This method returns an undefined value.

Register the given load balancing target as part of this group.

Parameters:



225
226
227
228
229
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 225

def add_load_balancer_target(props)
  props = props.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::LoadBalancerTargetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5Mb2FkQmFsYW5jZXJUYXJnZXRQcm9wcyJ9")), "props")
  jsii_call_method("addLoadBalancerTarget", [props])
end

#add_target(*targets) ⇒ void

This method returns an undefined value.

Add a load balancing target to this target group.

Parameters:



267
268
269
270
271
272
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 267

def add_target(*targets)
  targets.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5JQXBwbGljYXRpb25Mb2FkQmFsYW5jZXJUYXJnZXQifQ==")), "targets[#{index}]")
  end
  jsii_call_method("addTarget", [*targets])
end

#configure_health_check(health_check) ⇒ void

This method returns an undefined value.

Set/replace the target group's health check.

Parameters:



235
236
237
238
239
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 235

def configure_health_check(health_check)
  health_check = health_check.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::HealthCheck.new(**health_check.transform_keys(&:to_sym)) : health_check
  Jsii::Type.check_type(health_check, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5IZWFsdGhDaGVjayJ9")), "healthCheck")
  jsii_call_method("configureHealthCheck", [health_check])
end

#default_port ⇒ Numeric

Default port configured for members of this target group.

Returns:

  • (Numeric) 


85
86
87
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 85

def default_port()
  jsii_get_property("defaultPort")
end

#enable_cookie_stickiness(duration, cookie_name = nil) ⇒ void

This method returns an undefined value.

Enable sticky routing via a cookie to members of this target group.

Note: If the cookie_name parameter is set, application-based stickiness will be applied, otherwise it defaults to duration-based stickiness attributes (lb_cookie).

Parameters:

See Also:



283
284
285
286
287
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 283

def enable_cookie_stickiness(duration, cookie_name = nil)
  Jsii::Type.check_type(duration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "duration")
  Jsii::Type.check_type(cookie_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cookieName") unless cookie_name.nil?
  jsii_call_method("enableCookieStickiness", [duration, cookie_name])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

Returns:



92
93
94
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 92

def env()
  jsii_get_property("env")
end

#first_load_balancer_full_name ⇒ String

Full name of first load balancer.

Returns:

  • (String) 


99
100
101
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 99

def first_load_balancer_full_name()
  jsii_get_property("firstLoadBalancerFullName")
end

#health_check ⇒ AWSCDK::ElasticLoadBalancingv2::HealthCheck

Health check for the members of this target group.

Returns:



162
163
164
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 162

def health_check()
  jsii_get_property("healthCheck")
end

#health_check=(value) ⇒ Object 



166
167
168
169
170
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 166

def health_check=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ElasticLoadBalancingv2::HealthCheck.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5IZWFsdGhDaGVjayJ9")), "healthCheck")
  jsii_set_property("healthCheck", value)
end

#load_balancer_arns ⇒ String

A token representing a list of ARNs of the load balancers that route traffic to this target group.

Returns:

  • (String) 


106
107
108
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 106

def load_balancer_arns()
  jsii_get_property("loadBalancerArns")
end

#load_balancer_attached ⇒ Constructs::IDependable

List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer.

Returns:

  • (Constructs::IDependable) 


113
114
115
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 113

def load_balancer_attached()
  jsii_get_property("loadBalancerAttached")
end

#load_balancer_attached_dependencies ⇒ Constructs::DependencyGroup

Configurable dependable with all resources that lead to load balancer attachment.

Returns:

  • (Constructs::DependencyGroup) 


120
121
122
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 120

def load_balancer_attached_dependencies()
  jsii_get_property("loadBalancerAttachedDependencies")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: Average over 5 minutes

Return the given named metric for this Application Load Balancer Target Group.

Returns the metric for this target group from the point of view of the first load balancer load balancing to it. If you have multiple load balancers load sending traffic to the same target group, you will have to override the dimensions on this metric.

Parameters:

Returns:



300
301
302
303
304
305
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 300

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_healthy_host_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.healthyHostCount instead

Note:

Default: Average over 5 minutes

The number of healthy hosts in the target group.

Parameters:

Returns:



313
314
315
316
317
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 313

def metric_healthy_host_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricHealthyHostCount", [props])
end

#metric_http_code_target(code, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.httpCodeTarget instead

Note:

Default: Sum over 5 minutes

The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group.

This does not include any response codes generated by the load balancer.

Parameters:

Returns:



328
329
330
331
332
333
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 328

def metric_http_code_target(code, props = nil)
  Jsii::Type.check_type(code, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5IdHRwQ29kZVRhcmdldCJ9")), "code")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricHttpCodeTarget", [code, props])
end

#metric_ipv6_request_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.ipv6RequestCount instead

Note:

Default: Sum over 5 minutes

The number of IPv6 requests received by the target group.

Parameters:

Returns:



341
342
343
344
345
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 341

def metric_ipv6_request_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIpv6RequestCount", [props])
end

#metric_request_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.requestCount instead

Note:

Default: Sum over 5 minutes

The number of requests processed over IPv4 and IPv6.

This count includes only the requests with a response generated by a target of the load balancer.

Parameters:

Returns:



355
356
357
358
359
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 355

def metric_request_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricRequestCount", [props])
end

#metric_request_count_per_target(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.requestCountPerTarget instead

Note:

Default: Sum over 5 minutes

The average number of requests received by each target in a target group.

The only valid statistic is Sum. Note that this represents the average not the sum.

Parameters:

Returns:



369
370
371
372
373
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 369

def metric_request_count_per_target(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricRequestCountPerTarget", [props])
end

#metric_target_connection_error_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.targetConnectionErrorCount instead

Note:

Default: Sum over 5 minutes

The number of connections that were not successfully established between the load balancer and target.

Parameters:

Returns:



381
382
383
384
385
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 381

def metric_target_connection_error_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTargetConnectionErrorCount", [props])
end

#metric_target_response_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.targetResponseTime instead

Note:

Default: Average over 5 minutes

The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.

Parameters:

Returns:



393
394
395
396
397
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 393

def metric_target_response_time(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTargetResponseTime", [props])
end

#metric_target_tls_negotiation_error_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.tlsNegotiationErrorCount instead

Note:

Default: Sum over 5 minutes

The number of TLS connections initiated by the load balancer that did not establish a session with the target.

Possible causes include a mismatch of ciphers or protocols.

Parameters:

Returns:



407
408
409
410
411
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 407

def metric_target_tls_negotiation_error_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTargetTLSNegotiationErrorCount", [props])
end

#metric_unhealthy_host_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Deprecated.

Use ApplicationTargetGroup.metrics.unhealthyHostCount instead

Note:

Default: Average over 5 minutes

The number of unhealthy hosts in the target group.

Parameters:

Returns:



419
420
421
422
423
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 419

def metric_unhealthy_host_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricUnhealthyHostCount", [props])
end

#metrics ⇒ AWSCDK::ElasticLoadBalancingv2::IApplicationTargetGroupMetrics

All metrics available for this target group.

Returns:



194
195
196
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 194

def metrics()
  jsii_get_property("metrics")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


78
79
80
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 78

def node()
  jsii_get_property("node")
end

#register_connectable(connectable, port_range = nil) ⇒ void

This method returns an undefined value.

Register a connectable as a member of this target group.

Don't call this directly. It will be called by load balancing targets.

Parameters:



432
433
434
435
436
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 432

def register_connectable(connectable, port_range = nil)
  Jsii::Type.check_type(connectable, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklDb25uZWN0YWJsZSJ9")), "connectable")
  Jsii::Type.check_type(port_range, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlBvcnQifQ==")), "portRange") unless port_range.nil?
  jsii_call_method("registerConnectable", [connectable, port_range])
end

#register_listener(listener, associating_construct = nil) ⇒ void

This method returns an undefined value.

Register a listener that is load balancing to this target group.

Don't call this directly. It will be called by listeners.

Parameters:



445
446
447
448
449
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 445

def register_listener(listener, associating_construct = nil)
  Jsii::Type.check_type(listener, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5JQXBwbGljYXRpb25MaXN0ZW5lciJ9")), "listener")
  Jsii::Type.check_type(associating_construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklDb25zdHJ1Y3QifQ==")), "associatingConstruct") unless associating_construct.nil?
  jsii_call_method("registerListener", [listener, associating_construct])
end

#set_attribute(key, value = nil) ⇒ void

This method returns an undefined value.

Set a non-standard attribute on the target group.

Parameters:

  • key (String)
  • value (String, nil) (defaults to: nil)

See Also:



247
248
249
250
251
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 247

def set_attribute(key, value = nil)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless value.nil?
  jsii_call_method("setAttribute", [key, value])
end

#target_group_arn ⇒ String

The ARN of the target group.

Returns:

  • (String) 


127
128
129
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 127

def target_group_arn()
  jsii_get_property("targetGroupArn")
end

#target_group_full_name ⇒ String

The full name of the target group.

Returns:

  • (String) 


134
135
136
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 134

def target_group_full_name()
  jsii_get_property("targetGroupFullName")
end

#target_group_load_balancer_arns ⇒ Array<String>

ARNs of load balancers load balancing to this TargetGroup.

Returns:

  • (Array<String>) 


141
142
143
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 141

def target_group_load_balancer_arns()
  jsii_get_property("targetGroupLoadBalancerArns")
end

#target_group_name ⇒ String

The name of the target group.

Returns:

  • (String) 


148
149
150
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 148

def target_group_name()
  jsii_get_property("targetGroupName")
end

#target_group_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancingv2::TargetGroupReference

A reference to this target group.

Returns:



155
156
157
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 155

def target_group_ref()
  jsii_get_property("targetGroupRef")
end

#target_type ⇒ AWSCDK::ElasticLoadBalancingv2::TargetType?

The types of the directly registered members of this target group.

Returns:



175
176
177
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 175

def target_type()
  jsii_get_property("targetType")
end

#target_type=(value) ⇒ Object 



179
180
181
182
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 179

def target_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5UYXJnZXRUeXBlIn0=")), "targetType") unless value.nil?
  jsii_set_property("targetType", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


201
202
203
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 201

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

#validate_health_check ⇒ Array<String>

Returns:

  • (Array<String>) 


254
255
256
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 254

def validate_health_check()
  jsii_call_method("validateHealthCheck", [])
end

#validate_target_group ⇒ Array<String>

Returns:

  • (Array<String>) 


259
260
261
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 259

def validate_target_group()
  jsii_call_method("validateTargetGroup", [])
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>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



214
215
216
217
218
219
 
# File 'elastic_load_balancingv2/application_target_group.rb', line 214

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