ServerGroup

• Implements: IServerGroup

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

Initializers

import ros_cdk_gwlb
ros_cdk_gwlb.ServerGroup(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

vpc_id^Required

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

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

Property connectionDrainConfig: Connected graceful interrupt configuration.

health_check_config^Optional

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

Property healthCheckConfig: Health check configurations.

protocol^Optional

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

Property protocol: Backend Protocol.

Value: GENEVE (default).

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

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

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

servers^Optional

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

Property servers: List of servers.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of server group.

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_gwlb
ros_cdk_gwlb.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_connection_drain_config^Required

attr_connection_drain_config: typing.Union[str, IResolvable]

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

Attribute ConnectionDrainConfig: Connected graceful interrupt configuration.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation time of the server group.

attr_health_check_config^Required

attr_health_check_config: typing.Union[str, IResolvable]

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

Attribute HealthCheckConfig: Health check configurations.

attr_protocol^Required

attr_protocol: typing.Union[str, IResolvable]

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

Attribute Protocol: Backend Protocol.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_scheduler^Required

attr_scheduler: typing.Union[str, IResolvable]

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

Attribute Scheduler: Scheduling algorithm.

attr_server_group_id^Required

attr_server_group_id: typing.Union[str, IResolvable]

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

Attribute ServerGroupId: The server group ID.

attr_server_group_name^Required

attr_server_group_name: typing.Union[str, IResolvable]

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

Attribute ServerGroupName: The server group name.

attr_server_group_type^Required

attr_server_group_type: typing.Union[str, IResolvable]

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

Attribute ServerGroupType: The server group type.

attr_servers^Required

attr_servers: typing.Union[str, IResolvable]

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

Attribute Servers: List of servers.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: List of resource tags.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The VPC instance ID.

props^Required

props: ServerGroupProps

• Type: ServerGroupProps

Structs