TargetGroupBase

class aws_cdk.aws_elasticloadbalancingv2.TargetGroupBase(scope, id, base_props, additional_props)

Bases: aws_cdk.core.Construct

Define the target of a load balancer.

__init__(scope, id, base_props, additional_props)
Parameters
Return type

None

Methods

configure_health_check(*, healthy_http_codes=None, healthy_threshold_count=None, interval=None, path=None, port=None, protocol=None, timeout=None, unhealthy_threshold_count=None)

Set/replace the target group’s health check.

Parameters
  • health_check

  • healthy_http_codes (Optional[str]) – HTTP code to use when checking for a successful response from a target. For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

  • healthy_threshold_count (Union[int, float, None]) – The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3. Default: 5 for ALBs, 3 for NLBs

  • interval (Optional[Duration]) – The approximate number of seconds between health checks for an individual target. Default: Duration.seconds(30)

  • path (Optional[str]) – The ping path destination where Elastic Load Balancing sends health check requests. Default: /

  • port (Optional[str]) – The port that the load balancer uses when performing health checks on the targets. Default: ‘traffic-port’

  • protocol (Optional[Protocol]) – The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. Default: HTTP for ALBs, TCP for NLBs

  • timeout (Optional[Duration]) – The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2-60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks. Default: Duration.seconds(5) for ALBs, Duration.seconds(10) or Duration.seconds(6) for NLBs

  • unhealthy_threshold_count (Union[int, float, None]) – The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count. Default: 2

Return type

None

set_attribute(key, value=None)

Set a non-standard attribute on the target group.

Parameters
  • key (str) –

  • value (Optional[str]) –

see :see: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

first_load_balancer_full_name

Full name of first load balancer.

This identifier is emitted as a dimensions of the metrics of this target group.

Example::

# Example may have issues. See https://github.com/aws/jsii/issues/826 app / my - load - balancer / 123456789

Return type

str

health_check
Return type

HealthCheck

load_balancer_arns

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

Return type

str

load_balancer_attached

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

Return type

IDependable

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

target_group_arn

The ARN of the target group.

Return type

str

target_group_full_name

The full name of the target group.

Return type

str

target_group_load_balancer_arns

ARNs of load balancers load balancing to this TargetGroup.

Return type

List[str]

target_group_name

The name of the target group.

Return type

str

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool