Skip to content

ServerGroupProps

Properties for defining a ServerGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-alb-servergroup

Initializer 

import { ServerGroupProps } from '@alicloud/ros-cdk-alb'
const serverGroupProps: ServerGroupProps = { ... }

Properties

Name Type Description
healthCheckConfig @alicloud/ros-cdk-core.IResolvable | HealthCheckConfigProperty Property healthCheckConfig: The configuration of health checks.
serverGroupName string | @alicloud/ros-cdk-core.IResolvable Property serverGroupName: The name of the server group.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC).
connectionDrainConfig @alicloud/ros-cdk-core.IResolvable | ConnectionDrainConfigProperty Property connectionDrainConfig: Configuration related to graceful connection interruption.Enable graceful connection interruption. After the backend server is removed or the health check fails, the load balancing allows the existing connection to be transmitted normally within a certain period of time.Note: Basic Edition instances do not support enabling graceful connection interruption. Only Standard Edition and WAF Enhanced Edition instances support it.Server type and IP type server group support graceful connection interruption. Function Compute type does not support it.
protocol string | @alicloud/ros-cdk-core.IResolvable Property protocol: The backend protocol.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
scheduler string | @alicloud/ros-cdk-core.IResolvable Property scheduler: The scheduling algorithm.
serverGroupType string | @alicloud/ros-cdk-core.IResolvable Property serverGroupType: The type of the server group.
serviceName string | @alicloud/ros-cdk-core.IResolvable Property serviceName: This parameter is available only if the ALB Ingress controller is used.
slowStartConfig @alicloud/ros-cdk-core.IResolvable | SlowStartConfigProperty Property slowStartConfig: Slow start related configuration.After slow start is enabled, the backend server newly added to the backend server group will be preheated within the set time period, and the number of requests forwarded to the server will increase linearly.Note: Basic Edition instances do not support slow start, only Standard Edition and WAF Enhanced Edition instances support it.Server type and IP type server groups support slow start configuration, but Function Compute type does not.Slow start can only be enabled when the backend scheduling algorithm is the weighted polling algorithm.
stickySessionConfig @alicloud/ros-cdk-core.IResolvable | StickySessionConfigProperty Property stickySessionConfig: The configuration of session persistence.
tags TagsProperty[] Property tags: Tags to attach to instance.
uchConfig @alicloud/ros-cdk-core.IResolvable | UchConfigProperty Property uchConfig: URL consistency hash parameter configuration.
upstreamKeepaliveEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property upstreamKeepaliveEnabled: Whether to enable upstream keepalive.

healthCheckConfigRequired 

public readonly healthCheckConfig: IResolvable | HealthCheckConfigProperty;

Property healthCheckConfig: The configuration of health checks.

serverGroupNameRequired 

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

Property serverGroupName: The name of the server group.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

vpcIdRequired 

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

Property vpcId: The ID of the virtual private cloud (VPC).

You can add only servers that are deployed in the specified VPC to the server group. Note: This parameter is required if the ServerGroupType parameter is set to Instance or Ip. Note: This parameter takes effect when the ServerGroupType parameter is set to Instance or Ip.

connectionDrainConfigOptional 

public readonly connectionDrainConfig: IResolvable | ConnectionDrainConfigProperty;

Property connectionDrainConfig: Configuration related to graceful connection interruption.Enable graceful connection interruption. After the backend server is removed or the health check fails, the load balancing allows the existing connection to be transmitted normally within a certain period of time.Note: Basic Edition instances do not support enabling graceful connection interruption. Only Standard Edition and WAF Enhanced Edition instances support it.Server type and IP type server group support graceful connection interruption. Function Compute type does not support it.

protocolOptional 

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

Property protocol: The backend protocol.

Valid values: HTTP (default): The server group can be associated with HTTPS, HTTP, and QUIC listeners. HTTPS: The server group can be associated with HTTPS listeners. gRPC: The server group can be associated with HTTPS and QUIC listeners. Note: If the ServerGroupType parameter is set to Fc, you can set Protocol only to HTTP.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

schedulerOptional 

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

Property scheduler: The scheduling algorithm.

Valid values: Wrr (default): The weighted round-robin algorithm is used. Backend servers that have higher weights receive more requests than those that have lower weights. Wlc: The weighted least connections algorithm is used. Requests are distributed based on the weights and the number of connections to backend servers. If two backend servers have the same weight, the backend server that has fewer connections is expected to receive more requests. Sch: The consistent hashing algorithm is used. Requests from the same source IP address are distributed to the same backend server. Note: This parameter takes effect when the ServerGroupType parameter is set to Instance or Ip.

serverGroupTypeOptional 

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

Property serverGroupType: The type of the server group.

Valid values: Instance (default): allows you add servers by specifying Ecs, Ens, or Eci. Ip: allows you to add servers by specifying IP addresses. Fc: allows you to add servers by specifying functions of Function Compute.

serviceNameOptional 

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

Property serviceName: This parameter is available only if the ALB Ingress controller is used.

In this case, set the parameter to the name of the Kubernetes Service that is associated with the server group.

slowStartConfigOptional 

public readonly slowStartConfig: IResolvable | SlowStartConfigProperty;

Property slowStartConfig: Slow start related configuration.After slow start is enabled, the backend server newly added to the backend server group will be preheated within the set time period, and the number of requests forwarded to the server will increase linearly.Note: Basic Edition instances do not support slow start, only Standard Edition and WAF Enhanced Edition instances support it.Server type and IP type server groups support slow start configuration, but Function Compute type does not.Slow start can only be enabled when the backend scheduling algorithm is the weighted polling algorithm.

stickySessionConfigOptional 

public readonly stickySessionConfig: IResolvable | StickySessionConfigProperty;

Property stickySessionConfig: The configuration of session persistence.

Note: This parameter is required if the ServerGroupType parameter is set to Instance or Ip.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

uchConfigOptional 

public readonly uchConfig: IResolvable | UchConfigProperty;

Property uchConfig: URL consistency hash parameter configuration.

upstreamKeepaliveEnabledOptional 

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

Property upstreamKeepaliveEnabled: Whether to enable upstream keepalive.