Skip to content

EndpointGroupProps

Properties for defining a EndpointGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ga-endpointgroup

Initializer

import { EndpointGroupProps } from '@alicloud/ros-cdk-ga'
const endpointGroupProps: EndpointGroupProps = { ... }

Properties

Name Type Description
acceleratorId string | @alicloud/ros-cdk-core.IResolvable Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.
endpointConfigurations @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | EndpointConfigurationsProperty[] Property endpointConfigurations:.
endpointGroupRegion string | @alicloud/ros-cdk-core.IResolvable Property endpointGroupRegion: The region ID of the endpoint group.
listenerId string | @alicloud/ros-cdk-core.IResolvable Property listenerId: The ID of the listener to be associated with the endpoint group.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the endpoint group.
endpointGroupType string | @alicloud/ros-cdk-core.IResolvable Property endpointGroupType: The type of the endpoint group.
endpointRequestProtocol string | @alicloud/ros-cdk-core.IResolvable Property endpointRequestProtocol: The protocol used by the backend service.
healthCheckEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property healthCheckEnabled: Specifies whether to enable the health check feature.
healthCheckIntervalSeconds number | @alicloud/ros-cdk-core.IResolvable Property healthCheckIntervalSeconds: The interval between two consecutive health checks.
healthCheckPath string | @alicloud/ros-cdk-core.IResolvable Property healthCheckPath: The path set as the destination on the targets for health checks.
healthCheckPort number | @alicloud/ros-cdk-core.IResolvable Property healthCheckPort: The port that is used to connect with the targets for health checks.
healthCheckProtocol string | @alicloud/ros-cdk-core.IResolvable Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the endpoint group.
thresholdCount number | @alicloud/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.
trafficPercentage number | @alicloud/ros-cdk-core.IResolvable Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

acceleratorIdRequired

public readonly acceleratorId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.


endpointConfigurationsRequired

public readonly endpointConfigurations: IResolvable | IResolvable | EndpointConfigurationsProperty[];

Property endpointConfigurations:.


endpointGroupRegionRequired

public readonly endpointGroupRegion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpointGroupRegion: The region ID of the endpoint group.


listenerIdRequired

public readonly listenerId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property listenerId: The ID of the listener to be associated with the endpoint group.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the endpoint group.


endpointGroupTypeOptional

public readonly endpointGroupType: string | IResolvable;
  • Type: string | @alicloud/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.


endpointRequestProtocolOptional

public readonly endpointRequestProtocol: string | IResolvable;
  • Type: string | @alicloud/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.


healthCheckEnabledOptional

public readonly healthCheckEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property healthCheckEnabled: Specifies whether to enable the health check feature.


healthCheckIntervalSecondsOptional

public readonly healthCheckIntervalSeconds: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property healthCheckIntervalSeconds: The interval between two consecutive health checks.

Unit: seconds.


healthCheckPathOptional

public readonly healthCheckPath: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property healthCheckPath: The path set as the destination on the targets for health checks.


healthCheckPortOptional

public readonly healthCheckPort: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property healthCheckPort: The port that is used to connect with the targets for health checks.


healthCheckProtocolOptional

public readonly healthCheckProtocol: string | IResolvable;
  • Type: string | @alicloud/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

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the endpoint group.


thresholdCountOptional

public readonly thresholdCount: number | IResolvable;
  • Type: number | @alicloud/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.


trafficPercentageOptional

public readonly trafficPercentage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.