Skip to content

TargetGroup

Source code in docs_src/capo_elastic_load_balancing_v2/types/target_group.py
class TargetGroup(TypedDict, closed=True):
    target_group_arn: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_group_arn.TargetGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the target group.</p>"""
    target_group_name: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_group_name.TargetGroupName"
    ]
    """<p>The name of the target group.</p>"""
    protocol: NotRequired[
        "capo_elastic_load_balancing_v2.types.protocol_enum.ProtocolEnum"
    ]
    """<p>The protocol to use for routing traffic to the targets.</p>"""
    port: NotRequired["capo_elastic_load_balancing_v2.types.port.Port"]
    """<p>The port on which the targets are listening. This parameter is not used if the target is a Lambda function.</p>"""
    vpc_id: NotRequired["capo_elastic_load_balancing_v2.types.vpc_id.VpcId"]
    """<p>The ID of the VPC for the targets.</p>"""
    health_check_protocol: NotRequired[
        "capo_elastic_load_balancing_v2.types.protocol_enum.ProtocolEnum"
    ]
    """<p>The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.</p>"""
    health_check_port: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_port.HealthCheckPort"
    ]
    """<p>The port to use to connect with the target.</p>"""
    health_check_enabled: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_enabled.HealthCheckEnabled"
    ]
    """<p>Indicates whether health checks are enabled.</p>"""
    health_check_interval_seconds: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_interval_seconds.HealthCheckIntervalSeconds"
    ]
    """<p>The approximate amount of time, in seconds, between health checks of an individual target.</p>"""
    health_check_timeout_seconds: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_timeout_seconds.HealthCheckTimeoutSeconds"
    ]
    """<p>The amount of time, in seconds, during which no response means a failed health check.</p>"""
    healthy_threshold_count: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_threshold_count.HealthCheckThresholdCount"
    ]
    """<p>The number of consecutive health checks successes required before considering an unhealthy target healthy.</p>"""
    unhealthy_threshold_count: NotRequired[
        "capo_elastic_load_balancing_v2.types.health_check_threshold_count.HealthCheckThresholdCount"
    ]
    """<p>The number of consecutive health check failures required before considering the target unhealthy.</p>"""
    health_check_path: NotRequired["capo_elastic_load_balancing_v2.types.path.Path"]
    """<p>The destination for health checks on the targets.</p>"""
    matcher: NotRequired["capo_elastic_load_balancing_v2.types.matcher.Matcher"]
    """<p>The HTTP or gRPC codes to use when checking for a successful response from a target.</p>"""
    load_balancer_arns: NotRequired[
        "capo_elastic_load_balancing_v2.types.load_balancer_arns.LoadBalancerArns"
    ]
    """<p>The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.</p>"""
    target_type: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_type_enum.TargetTypeEnum"
    ]
    """<p>The type of target that you must specify when registering targets with this target group. The possible values are <code>instance</code> (register targets by instance ID), <code>ip</code> (register targets by IP address), <code>lambda</code> (register a single Lambda function as a target), or <code>alb</code> (register a single Application Load Balancer as a target).</p>"""
    protocol_version: NotRequired[
        "capo_elastic_load_balancing_v2.types.protocol_version.ProtocolVersion"
    ]
    """<p>[HTTP/HTTPS protocol] The protocol version. The possible values are <code>GRPC</code>, <code>HTTP1</code>, and <code>HTTP2</code>.</p>"""
    ip_address_type: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_group_ip_address_type_enum.TargetGroupIpAddressTypeEnum"
    ]
    """<p>The IP address type. The default value is <code>ipv4</code>.</p>"""
    target_control_port: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_control_port.TargetControlPort"
    ]
    """<p>The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.</p>"""

health_check_enabled instance-attribute

health_check_enabled: NotRequired[HealthCheckEnabled]

Indicates whether health checks are enabled.

health_check_interval_seconds instance-attribute

health_check_interval_seconds: NotRequired[HealthCheckIntervalSeconds]

The approximate amount of time, in seconds, between health checks of an individual target.

health_check_path instance-attribute

health_check_path: NotRequired[Path]

The destination for health checks on the targets.

health_check_port instance-attribute

health_check_port: NotRequired[HealthCheckPort]

The port to use to connect with the target.

health_check_protocol instance-attribute

health_check_protocol: NotRequired[ProtocolEnum]

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

health_check_timeout_seconds instance-attribute

health_check_timeout_seconds: NotRequired[HealthCheckTimeoutSeconds]

The amount of time, in seconds, during which no response means a failed health check.

healthy_threshold_count instance-attribute

healthy_threshold_count: NotRequired[HealthCheckThresholdCount]

The number of consecutive health checks successes required before considering an unhealthy target healthy.

ip_address_type instance-attribute

ip_address_type: NotRequired[TargetGroupIpAddressTypeEnum]

The IP address type. The default value is ipv4.

load_balancer_arns instance-attribute

load_balancer_arns: NotRequired[LoadBalancerArns]

The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.

matcher instance-attribute

matcher: NotRequired[Matcher]

The HTTP or gRPC codes to use when checking for a successful response from a target.

port instance-attribute

port: NotRequired[Port]

The port on which the targets are listening. This parameter is not used if the target is a Lambda function.

protocol instance-attribute

protocol: NotRequired[ProtocolEnum]

The protocol to use for routing traffic to the targets.

protocol_version instance-attribute

protocol_version: NotRequired[ProtocolVersion]

[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

target_control_port instance-attribute

target_control_port: NotRequired[TargetControlPort]

The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.

target_group_arn instance-attribute

target_group_arn: NotRequired[TargetGroupArn]

The Amazon Resource Name (ARN) of the target group.

target_group_name instance-attribute

target_group_name: NotRequired[TargetGroupName]

The name of the target group.

target_type instance-attribute

target_type: NotRequired[TargetTypeEnum]

The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

unhealthy_threshold_count instance-attribute

unhealthy_threshold_count: NotRequired[HealthCheckThresholdCount]

The number of consecutive health check failures required before considering the target unhealthy.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the VPC for the targets.