Skip to content

LoadBalancerProps

Properties for defining a LoadBalancer.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-slb-loadbalancer

Initializer 

import ros_cdk_slb
ros_cdk_slb.LoadBalancerProps(
  address_ip_version: typing.Union[str, IResolvable] = None,
  address_type: typing.Union[str, IResolvable] = None,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  load_balancer_name: typing.Union[str, IResolvable] = None,
  load_balancer_spec: typing.Union[str, IResolvable] = None,
  master_zone_id: typing.Union[str, IResolvable] = None,
  modification_protection_reason: typing.Union[str, IResolvable] = None,
  modification_protection_status: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  slave_zone_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
address_ip_version typing.Union[str, ros_cdk_core.IResolvable] Property addressIpVersion: The IP version of the CLB instance.
address_type typing.Union[str, ros_cdk_core.IResolvable] Property addressType: The network type of the CLB instance.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The bandwidth for network, unit in Mbps(Mega bit per second).
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Whether to enable deletion protection.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The resource metering method for the CLB instance.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: The metering method of the Internet-facing CLB instance.
load_balancer_name typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerName: The CLB instance name.
load_balancer_spec typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerSpec: The specification of the CLB instance.
master_zone_id typing.Union[str, ros_cdk_core.IResolvable] Property masterZoneId: The master zone id to create load balancer instance.
modification_protection_reason typing.Union[str, ros_cdk_core.IResolvable] Property modificationProtectionReason: The reason for enabling the configuration read-only mode.
modification_protection_status typing.Union[str, ros_cdk_core.IResolvable] Property modificationProtectionStatus: Specifies whether to enable the configuration read-only mode.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
slave_zone_id typing.Union[str, ros_cdk_core.IResolvable] Property slaveZoneId: The slave zone id to create load balancer instance.
tags typing.List[TagsProperty] Property tags: Tags to attach to slb.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC id to create load balancer instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the vSwitch to which the CLB instance belongs.

address_ip_versionOptional 

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

Property addressIpVersion: The IP version of the CLB instance.

Valid values: ipv4 and ipv6.

address_typeOptional 

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

Property addressType: The network type of the CLB instance.

Valid values:

  • internet (default): After an internet-facing CLB instance is created, the system assigns a public IP address to the CLB instance. Then, the CLB instance can forward requests over the Internet.
  • intranet: After an internal-facing CLB instance is created, the system assigns a private IP address to the CLB instance. Then, the CLB instance can forward requests only over the internal networks.

bandwidthOptional 

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

Property bandwidth: The bandwidth for network, unit in Mbps(Mega bit per second).

Default is 1. If InternetChargeType is specified as "paybytraffic", this property will be ignore and please specify the "Bandwidth" in ALIYUN::SLB::Listener.

deletion_protectionOptional 

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

Property deletionProtection: Whether to enable deletion protection.

instance_charge_typeOptional 

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

Property instanceChargeType: The resource metering method for the CLB instance.

Valid value:

  • PayByCLCU: pay-by-data-transfer

As of 00:00:00 (UTC+8) on June 1, 2025, pay-by-specification CLB instances are no longer available for purchase. For more details, see .

internet_charge_typeOptional 

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

Property internetChargeType: The metering method of the Internet-facing CLB instance.

Valid values:

  • paybytraffic (default): If you set the value to paybytraffic, you do not need to specify Bandwidth. Even if you specify Bandwidth, the value does not take effect.
  • paybybandwidth: pay-by-bandwidth. Note If you set PayType to PayOnDemand and set InstanceChargeType to PayByCLCU, you must set InternetChargeType to paybytraffic.

load_balancer_nameOptional 

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

Property loadBalancerName: The CLB instance name.

The name must be 1 to 80 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. If you do not specify this parameter, the system automatically assigns a name to the CLB instance.

load_balancer_specOptional 

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

Property loadBalancerSpec: The specification of the CLB instance.

Valid values:

  • slb.s1.small
  • slb.s2.small
  • slb.s2.medium
  • slb.s3.small
  • slb.s3.medium
  • slb.s3.large
  • If InstanceChargeType is set to PayByCLCU, this parameter is invalid and you do not need to specify this parameter.
  • As of 00:00:00 (UTC+8) on June 1, 2025, pay-by-specification CLB instances are no longer available for purchase. For more details, see .

master_zone_idOptional 

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

Property masterZoneId: The master zone id to create load balancer instance.

modification_protection_reasonOptional 

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

Property modificationProtectionReason: The reason for enabling the configuration read-only mode.

The reason must be 1 to 80 characters in length. It must start with a letter and can contain letters, digits, periods (.), underscores (_), and hyphens (-).

This parameter takes effect only when ModificationProtectionStatus is set to ConsoleProtection.

modification_protection_statusOptional 

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

Property modificationProtectionStatus: Specifies whether to enable the configuration read-only mode.

Valid values:

  • NonProtection: disables the configuration read-only mode. After you disable the configuration read-only mode, the value of ModificationProtectionReason is cleared.
  • ConsoleProtection: enables the configuration read-only mode.

If you set this parameter to ConsoleProtection, you cannot modify instance configurations in the CLB console. However, you can modify instance configurations by calling API operations.

resource_group_idOptional 

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

Property resourceGroupId: Resource group id.

slave_zone_idOptional 

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

Property slaveZoneId: The slave zone id to create load balancer instance.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tags to attach to slb.

Max support 5 tags to add during create slb. Each tag with two properties Key and Value, and Key is required.

vpc_idOptional 

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

Property vpcId: The VPC id to create load balancer instance.

For VPC network only.

v_switch_idOptional 

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

Property vSwitchId: The ID of the vSwitch to which the CLB instance belongs.

If you want to deploy the CLB instance in a VPC, this parameter is required. If this parameter is specified, AddessType is set to intranet by default.

The vSwitch must be in the primary zone.