ServerGroup

• Implements: IServerGroup

This class encapsulates and extends the ROS resource type ALIYUN::ALB::ServerGroup.

Initializers

import ros_cdk_alb
ros_cdk_alb.ServerGroup(
  scope: Construct,
  id: str,
  health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty],
  server_group_name: typing.Union[str, IResolvable],
  connection_drain_config: typing.Union[IResolvable, ConnectionDrainConfigProperty] = None,
  cross_zone_enabled: typing.Union[bool, IResolvable] = None,
  ipv6_enabled: typing.Union[bool, IResolvable] = 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,
  vpc_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

health_check_config^Required

• Type: typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty]

Property healthCheckConfig: The configuration of health checks.

server_group_name^Required

• 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, start with a letter, digit, or Chinese character, and can contain digits, periods (.), underscores (_), hyphens (-), and spaces.

connection_drain_config^Optional

• Type: 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.

cross_zone_enabled^Optional

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

Property crossZoneEnabled: Specifies whether to enable cross-zone load balancing for the server group.

Valid values:

• true (default): Enables cross-zone load balancing.
• false: Disables cross-zone load balancing.

• Basic ALB instances cannot be associated with server groups for which cross-zone load balancing is disabled. This feature is supported only by standard and WAF-enabled ALB instances.
• You can disable cross-zone load balancing for instance-type and IP-type server groups, but not for function-type server groups.
• You cannot enable sticky sessions if you disable cross-zone load balancing.

ipv6_enabled^Optional

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

Property ipv6Enabled: Whether to enable IPv6.

protocol^Optional

• 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_id^Optional

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

Property resourceGroupId: The ID of the resource group.

scheduler^Optional

• 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_type^Optional

• 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_name^Optional

• 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_config^Optional

• Type: 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^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, StickySessionConfigProperty]

Property stickySessionConfig: The configuration of session persistence.

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

tags^Optional

• Type: 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_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, UchConfigProperty]

Property uchConfig: URL consistency hash parameter configuration.

upstream_keepalive_enabled^Optional

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

Property upstreamKeepaliveEnabled: Whether to enable upstream keepalive.

vpc_id^Optional

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

Property vpcId: The ID of the VPC where the server group is created.

You can add only servers within this VPC to the server group.

This parameter is valid only when ServerGroupType is set to Instance or Ip.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_alb
ros_cdk_alb.ServerGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_server_group_id^Required

attr_server_group_id: typing.Union[str, IResolvable]

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

Attribute ServerGroupId: The ID of the server group.

props^Required

props: ServerGroupProps

• Type: ServerGroupProps