Skip to content

EndpointGroup

Source code in docs_src/capo_global_accelerator/types/endpoint_group.py
class EndpointGroup(TypedDict, closed=True):
    endpoint_group_arn: NotRequired[
        "capo_global_accelerator.types.generic_string.GenericString"
    ]
    """<p>The Amazon Resource Name (ARN) of the endpoint group.</p>"""
    endpoint_group_region: NotRequired[
        "capo_global_accelerator.types.generic_string.GenericString"
    ]
    """<p>The Amazon Web Services Region where the endpoint group is located.</p>"""
    endpoint_descriptions: NotRequired[
        "capo_global_accelerator.types.endpoint_descriptions.EndpointDescriptions"
    ]
    """<p>The list of endpoint objects.</p>"""
    traffic_dial_percentage: NotRequired[
        "capo_global_accelerator.types.traffic_dial_percentage.TrafficDialPercentage"
    ]
    """<p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>"""
    health_check_port: NotRequired[
        "capo_global_accelerator.types.health_check_port.HealthCheckPort"
    ]
    """<p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p> <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.</p>"""
    health_check_protocol: NotRequired[
        "capo_global_accelerator.types.health_check_protocol.HealthCheckProtocol"
    ]
    """<p>The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.</p>"""
    health_check_path: NotRequired[
        "capo_global_accelerator.types.health_check_path.HealthCheckPath"
    ]
    """<p>If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).</p>"""
    health_check_interval_seconds: NotRequired[
        "capo_global_accelerator.types.health_check_interval_seconds.HealthCheckIntervalSeconds"
    ]
    """<p>The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.</p>"""
    threshold_count: NotRequired[
        "capo_global_accelerator.types.threshold_count.ThresholdCount"
    ]
    """<p>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.</p>"""
    port_overrides: NotRequired[
        "capo_global_accelerator.types.port_overrides.PortOverrides"
    ]
    """<p>Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on. </p>"""

endpoint_descriptions instance-attribute

endpoint_descriptions: NotRequired[EndpointDescriptions]

The list of endpoint objects.

endpoint_group_arn instance-attribute

endpoint_group_arn: NotRequired[GenericString]

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

endpoint_group_region instance-attribute

endpoint_group_region: NotRequired[GenericString]

The Amazon Web Services Region where the endpoint group is located.

health_check_interval_seconds instance-attribute

health_check_interval_seconds: NotRequired[HealthCheckIntervalSeconds]

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

health_check_path instance-attribute

health_check_path: NotRequired[HealthCheckPath]

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

health_check_port instance-attribute

health_check_port: NotRequired[HealthCheckPort]

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

health_check_protocol instance-attribute

health_check_protocol: NotRequired[HealthCheckProtocol]

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

port_overrides instance-attribute

port_overrides: NotRequired[PortOverrides]

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

threshold_count instance-attribute

threshold_count: NotRequired[ThresholdCount]

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

traffic_dial_percentage instance-attribute

traffic_dial_percentage: NotRequired[TrafficDialPercentage]

The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.