Skip to content

ServerGroupProps

Properties for defining a ServerGroup.

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

Initializer

import ros_cdk_gwlb
ros_cdk_gwlb.ServerGroupProps(
  vpc_id: typing.Union[str, IResolvable],
  connection_drain_config: typing.Union[IResolvable, ConnectionDrainConfigProperty] = None,
  health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty] = None,
  protocol: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scheduler: typing.Union[str, IResolvable] = None,
  server_group_name: typing.Union[str, IResolvable] = None,
  server_group_type: typing.Union[str, IResolvable] = None,
  servers: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServersProperty]]] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC instance ID.
connection_drain_config typing.Union[ros_cdk_core.IResolvable, ConnectionDrainConfigProperty] Property connectionDrainConfig: Connected graceful interrupt configuration.
health_check_config typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty] Property healthCheckConfig: Health check configurations.
protocol typing.Union[str, ros_cdk_core.IResolvable] Property protocol: 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: Scheduling algorithm.
server_group_name typing.Union[str, ros_cdk_core.IResolvable] Property serverGroupName: The server group name.
server_group_type typing.Union[str, ros_cdk_core.IResolvable] Property serverGroupType: The server group type.
servers typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServersProperty]]] Property servers: List of servers.
tags typing.List[TagsProperty] Property tags: Tags of server group.

vpc_idRequired

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

Property vpcId: The VPC instance ID.

If the value of ServerGroupType is Instance, only servers in the VPC can be added to the server group.


connection_drain_configOptional

connection_drain_config: typing.Union[IResolvable, ConnectionDrainConfigProperty]

Property connectionDrainConfig: Connected graceful interrupt configuration.


health_check_configOptional

health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty]

Property healthCheckConfig: Health check configurations.


protocolOptional

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

Property protocol: Backend Protocol.

Value: GENEVE (default).


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: Scheduling algorithm.

Value:

  • 5TCH (default): quintuple hash, which is based on the consistent hash of the quintuple (source IP, Destination IP, source port, destination port, and protocol). The same flow is scheduled to the same backend server.
  • 3TCH: a three-tuple hash, which is based on the consistent hash of three tuples (source IP address, destination IP address, and protocol). The same flow is dispatched to the same backend server.
  • 2TCH: Binary Group hash, which is based on the consistent hash of the binary group (source IP and destination IP). The same flow is scheduled to the same backend server.

server_group_nameOptional

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

Property serverGroupName: The server group name.

It must be 2 to 128 characters in length, start with an uppercase letter or a Chinese character, and can contain digits, half-width periods (.), underscores (_), and dashes (-).


server_group_typeOptional

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

Property serverGroupType: The server group type.

Value:

  • Instance (default): The instance type. You can add Ecs, Eni, and Eci instances to the server group.
  • Ip: The Ip address type. You can directly add backend servers of the Ip address type to the server group.

serversOptional

servers: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServersProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServersProperty]]]

Property servers: List of servers.


tagsOptional

tags: typing.List[TagsProperty]

Property tags: Tags of server group.