ServerGroup

This class encapsulates and extends the ROS resource type ALIYUN::NLB::ServerGroup, which is used to create a server group for a Network Load Balancer (NLB) instance.

Initializers

import ros_cdk_nlb
ros_cdk_nlb.ServerGroup(
  scope: Construct,
  id: str,
  server_group_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  address_ip_version: typing.Union[str, IResolvable] = None,
  any_port_enabled: typing.Union[bool, IResolvable] = None,
  connection_drain_enabled: typing.Union[bool, IResolvable] = None,
  connection_drain_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty] = None,
  persistence_enabled: typing.Union[bool, IResolvable] = None,
  persistence_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  preserve_client_ip_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,
  servers: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServersProperty]]] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
server_group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property serverGroupName: Name of ServerGroup.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vpcId: ID of VPC.
address_ip_version	typing.Union[str, ros_cdk_core.IResolvable]	Property addressIpVersion: IP version of address.
any_port_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	Property anyPortEnabled: Specifies whether to enable all-port forwarding.
connection_drain_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	Property connectionDrainEnabled: Whether to enable graceful connection interruption.
connection_drain_timeout	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property connectionDrainTimeout: Time of graceful connection interruption.
health_check_config	typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty]	Property healthCheckConfig: Health Check Config.
persistence_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	Property persistenceEnabled: Whether to enable session persistence.
persistence_timeout	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property persistenceTimeout: Time of session persistence.
preserve_client_ip_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	Property preserveClientIpEnabled: Whether to enable the client address retention function.
protocol	typing.Union[str, ros_cdk_core.IResolvable]	Property protocol: Protocol of ServerGroup.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: undefined.
scheduler	typing.Union[str, ros_cdk_core.IResolvable]	Property scheduler: undefined.
server_group_type	typing.Union[str, ros_cdk_core.IResolvable]	Property serverGroupType: Type of ServerGroup.
servers	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServersProperty]]]	Property servers: undefined.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to instance.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

server_group_name^Required

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

Property serverGroupName: Name of ServerGroup.

---

vpc_id^Required

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

Property vpcId: ID of VPC.

---

address_ip_version^Optional

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

Property addressIpVersion: IP version of address.

---

any_port_enabled^Optional

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

Property anyPortEnabled: Specifies whether to enable all-port forwarding.

Valid values: true false (default)

---

connection_drain_enabled^Optional

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

Property connectionDrainEnabled: Whether to enable graceful connection interruption.

---

connection_drain_timeout^Optional

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

Property connectionDrainTimeout: Time of graceful connection interruption.

---

health_check_config^Optional

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

Property healthCheckConfig: Health Check Config.

---

persistence_enabled^Optional

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

Property persistenceEnabled: Whether to enable session persistence.

---

persistence_timeout^Optional

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

Property persistenceTimeout: Time of session persistence.

---

preserve_client_ip_enabled^Optional

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

Property preserveClientIpEnabled: Whether to enable the client address retention function.

---

protocol^Optional

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

Property protocol: Protocol of ServerGroup.

---

resource_group_id^Optional

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

Property resourceGroupId: undefined.

---

scheduler^Optional

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

Property scheduler: undefined.

---

server_group_type^Optional

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

Property serverGroupType: Type of ServerGroup.

---

servers^Optional

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

Property servers: undefined.

---

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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_server_group_id	ros_cdk_core.IResolvable	Attribute ServerGroupId: ID of ServerGroup.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_server_group_id^Required

attr_server_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ServerGroupId: ID of ServerGroup.

---

Structs