Skip to content

ServerGroupProps

Properties for defining a ServerGroup.

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

Initializer 

import ros_cdk_alb
ros_cdk_alb.ServerGroupProps(
  health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty],
  server_group_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  connection_drain_config: typing.Union[IResolvable, ConnectionDrainConfigProperty] = None,
  protocol: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scheduler: typing.Union[str, IResolvable] = None,
  server_group_type: typing.Union[str, IResolvable] = None,
  service_name: typing.Union[str, IResolvable] = None,
  slow_start_config: typing.Union[IResolvable, SlowStartConfigProperty] = None,
  sticky_session_config: typing.Union[IResolvable, StickySessionConfigProperty] = None,
  tags: typing.List[TagsProperty] = None,
  uch_config: typing.Union[IResolvable, UchConfigProperty] = None,
  upstream_keepalive_enabled: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
health_check_config typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty] Property healthCheckConfig: The configuration of health checks.
server_group_name typing.Union[str, ros_cdk_core.IResolvable] Property serverGroupName: The name of the server group.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC).
connection_drain_config typing.Union[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 typing.Union[str, ros_cdk_core.IResolvable] Property protocol: The backend protocol.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
scheduler typing.Union[str, ros_cdk_core.IResolvable] Property scheduler: The scheduling algorithm.
server_group_type typing.Union[str, ros_cdk_core.IResolvable] Property serverGroupType: The type of the server group.
service_name typing.Union[str, ros_cdk_core.IResolvable] Property serviceName: This parameter is available only if the ALB Ingress controller is used.
slow_start_config typing.Union[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.
sticky_session_config typing.Union[ros_cdk_core.IResolvable, StickySessionConfigProperty] Property stickySessionConfig: The configuration of session persistence.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
uch_config typing.Union[ros_cdk_core.IResolvable, UchConfigProperty] Property uchConfig: URL consistency hash parameter configuration.
upstream_keepalive_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property upstreamKeepaliveEnabled: Whether to enable upstream keepalive.

health_check_configRequired 

health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty]

Property healthCheckConfig: The configuration of health checks.

server_group_nameRequired 

server_group_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

vpc_idRequired 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

connection_drain_configOptional 

connection_drain_config: typing.Union[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 

protocol: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

schedulerOptional 

scheduler: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

server_group_typeOptional 

server_group_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

service_nameOptional 

service_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

slow_start_configOptional 

slow_start_config: typing.Union[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.

sticky_session_configOptional 

sticky_session_config: typing.Union[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 

tags: typing.List[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.

uch_configOptional 

uch_config: typing.Union[IResolvable, UchConfigProperty]

Property uchConfig: URL consistency hash parameter configuration.

upstream_keepalive_enabledOptional 

upstream_keepalive_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property upstreamKeepaliveEnabled: Whether to enable upstream keepalive.