CfnEndpointGroupProps
- class aws_cdk.aws_globalaccelerator.CfnEndpointGroupProps(*, endpoint_group_region, listener_arn, endpoint_configurations=None, health_check_interval_seconds=None, health_check_path=None, health_check_port=None, health_check_protocol=None, port_overrides=None, threshold_count=None, traffic_dial_percentage=None)
Bases:
objectProperties for defining a
CfnEndpointGroup.- Parameters:
endpoint_group_region (
str) – The AWS Regions where the endpoint group is located.listener_arn (
str) – The Amazon Resource Name (ARN) of the listener.endpoint_configurations (
Union[IResolvable,Sequence[Union[IResolvable,EndpointConfigurationProperty,Dict[str,Any]]],None]) – The list of endpoint objects.health_check_interval_seconds (
Union[int,float,None]) – The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.health_check_path (
Optional[str]) – 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 (
Union[int,float,None]) – 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 (
Optional[str]) – 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 (
Union[IResolvable,Sequence[Union[IResolvable,PortOverrideProperty,Dict[str,Any]]],None]) – 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 (
Union[int,float,None]) – 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 (
Union[int,float,None]) – The percentage of traffic to send to an AWS Regions . 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_globalaccelerator as globalaccelerator cfn_endpoint_group_props = globalaccelerator.CfnEndpointGroupProps( endpoint_group_region="endpointGroupRegion", listener_arn="listenerArn", # the properties below are optional endpoint_configurations=[globalaccelerator.CfnEndpointGroup.EndpointConfigurationProperty( endpoint_id="endpointId", # the properties below are optional client_ip_preservation_enabled=False, weight=123 )], health_check_interval_seconds=123, health_check_path="healthCheckPath", health_check_port=123, health_check_protocol="healthCheckProtocol", port_overrides=[globalaccelerator.CfnEndpointGroup.PortOverrideProperty( endpoint_port=123, listener_port=123 )], threshold_count=123, traffic_dial_percentage=123 )
Attributes
- endpoint_configurations
The list of endpoint objects.
- endpoint_group_region
The AWS Regions where the endpoint group is located.
- health_check_interval_seconds
The time—10 seconds or 30 seconds—between health checks for each endpoint.
The default value is 30.
- health_check_path
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
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
The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
The default value is TCP.
- listener_arn
The Amazon Resource Name (ARN) of the listener.
- port_overrides
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
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
The percentage of traffic to send to an AWS Regions .
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.