EndpointGroupProps
Properties for defining a EndpointGroup.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ga-endpointgroup
Initializer
import ros_cdk_ga
ros_cdk_ga.EndpointGroupProps(
accelerator_id: typing.Union[str, IResolvable],
endpoint_configurations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EndpointConfigurationsProperty]]],
endpoint_group_region: typing.Union[str, IResolvable],
listener_id: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
endpoint_group_type: typing.Union[str, IResolvable] = None,
endpoint_ip_version: typing.Union[str, IResolvable] = None,
endpoint_protocol_version: typing.Union[str, IResolvable] = None,
endpoint_request_protocol: typing.Union[str, IResolvable] = None,
health_check_enabled: typing.Union[bool, IResolvable] = None,
health_check_host: typing.Union[str, IResolvable] = None,
health_check_interval_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_path: typing.Union[str, IResolvable] = None,
health_check_port: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_protocol: typing.Union[str, IResolvable] = None,
name: typing.Union[str, IResolvable] = None,
port_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PortOverridesProperty]]] = None,
tags: typing.List[TagsProperty] = None,
threshold_count: typing.Union[typing.Union[int, float], IResolvable] = None,
traffic_percentage: typing.Union[typing.Union[int, float], IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
accelerator_id | typing.Union[str, ros_cdk_core.IResolvable] | Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated. |
endpoint_configurations | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointConfigurationsProperty]]] | Property endpointConfigurations:. |
endpoint_group_region | typing.Union[str, ros_cdk_core.IResolvable] | Property endpointGroupRegion: The region ID of the endpoint group. |
listener_id | typing.Union[str, ros_cdk_core.IResolvable] | Property listenerId: The ID of the listener to be associated with the endpoint group. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the endpoint group. |
endpoint_group_type | typing.Union[str, ros_cdk_core.IResolvable] | Property endpointGroupType: The type of the endpoint group. |
endpoint_ip_version | typing.Union[str, ros_cdk_core.IResolvable] | Property endpointIpVersion: The IP address protocol version of the backend service. |
endpoint_protocol_version | typing.Union[str, ros_cdk_core.IResolvable] | Property endpointProtocolVersion: The protocol version of the backend service. |
endpoint_request_protocol | typing.Union[str, ros_cdk_core.IResolvable] | Property endpointRequestProtocol: The protocol used by the backend service. |
health_check_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property healthCheckEnabled: Specifies whether to enable the health check feature. |
health_check_host | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckHost: The domain name that is used for health checks. |
health_check_interval_seconds | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckIntervalSeconds: The interval between two consecutive health checks. |
health_check_path | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckPath: The path set as the destination on the targets for health checks. |
health_check_port | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckPort: The port that is used to connect with the targets for health checks. |
health_check_protocol | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks. |
name | typing.Union[str, ros_cdk_core.IResolvable] | Property name: The name of the endpoint group. |
port_overrides | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PortOverridesProperty]]] | Property portOverrides: The port mapping relationship of the endpoint group. |
tags | typing.List[TagsProperty] | Property tags: Tags to attach to endpoint group. |
threshold_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy. |
traffic_percentage | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups. |
accelerator_idRequired
accelerator_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.
endpoint_configurationsRequired
endpoint_configurations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EndpointConfigurationsProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointConfigurationsProperty]]]
Property endpointConfigurations:.
endpoint_group_regionRequired
endpoint_group_region: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpointGroupRegion: The region ID of the endpoint group.
listener_idRequired
listener_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property listenerId: The ID of the listener to be associated with the endpoint group.
descriptionOptional
description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the endpoint group.
endpoint_group_typeOptional
endpoint_group_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpointGroupType: The type of the endpoint group.
Valid values: default: The endpoint group is a default endpoint group. This is the default value. virtual: The endpoint group is a virtual endpoint group. Note Only HTTP and HTTPS listeners support virtual endpoint groups.
endpoint_ip_versionOptional
endpoint_ip_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpointIpVersion: The IP address protocol version of the backend service.
Valid values: IPv4 IPv6 ProtocolAffinity
endpoint_protocol_versionOptional
endpoint_protocol_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpointProtocolVersion: The protocol version of the backend service.
Valid values: HTTP1.1 HTTP2 Note This parameter is valid only when the listener uses HTTPS.
endpoint_request_protocolOptional
endpoint_request_protocol: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property endpointRequestProtocol: The protocol used by the backend service.
Valid values: HTTP: This is the default value. HTTPS Note: You can set this parameter only when the listener that is associated with the endpoint group uses HTTP or HTTPS. For an HTTP listener, the backend service protocol must be HTTP.
health_check_enabledOptional
health_check_enabled: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property healthCheckEnabled: Specifies whether to enable the health check feature.
health_check_hostOptional
health_check_host: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckHost: The domain name that is used for health checks.
health_check_interval_secondsOptional
health_check_interval_seconds: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckIntervalSeconds: The interval between two consecutive health checks.
Unit: seconds.
health_check_pathOptional
health_check_path: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckPath: The path set as the destination on the targets for health checks.
health_check_portOptional
health_check_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckPort: The port that is used to connect with the targets for health checks.
health_check_protocolOptional
health_check_protocol: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.
tcp: TCP protocol http: HTTP protocol https: HTTPS protocol
nameOptional
name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of the endpoint group.
port_overridesOptional
port_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PortOverridesProperty]]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PortOverridesProperty]]]
Property portOverrides: The port mapping relationship of the endpoint group.
tagsOptional
tags: typing.List[TagsProperty]
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to endpoint group.
Max support 20 tags to add during create endpoint group. Each tag with two properties Key and Value, and Key is required.
threshold_countOptional
threshold_count: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.
Valid values: 2 to 10. Default value: 3.
traffic_percentageOptional
traffic_percentage: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.