LoadBalancerProps

Properties for defining a LoadBalancer.

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

Initializer

import { LoadBalancerProps } from '@alicloud/ros-cdk-slb'
const loadBalancerProps: LoadBalancerProps = { ... }

Properties

addressIpVersion^Optional

public readonly addressIpVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property addressIpVersion: The IP version of the CLB instance.

Valid values: ipv4 and ipv6.

addressType^Optional

public readonly addressType: string | IResolvable;

• Type: string | @alicloud/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.

bandwidth^Optional

public readonly bandwidth: number | IResolvable;

• Type: number | @alicloud/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.

deletionProtection^Optional

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

instanceChargeType^Optional

public readonly instanceChargeType: string | IResolvable;

• Type: string | @alicloud/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 .

internetChargeType^Optional

public readonly internetChargeType: string | IResolvable;

• Type: string | @alicloud/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.

loadBalancerName^Optional

public readonly loadBalancerName: string | IResolvable;

• Type: string | @alicloud/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.

loadBalancerSpec^Optional

public readonly loadBalancerSpec: string | IResolvable;

• Type: string | @alicloud/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 .

masterZoneId^Optional

public readonly masterZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

modificationProtectionReason^Optional

public readonly modificationProtectionReason: string | IResolvable;

• Type: string | @alicloud/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.

modificationProtectionStatus^Optional

public readonly modificationProtectionStatus: string | IResolvable;

• Type: string | @alicloud/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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

slaveZoneId^Optional

public readonly slaveZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

tags^Optional

public readonly tags: TagsProperty[];

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

vpcId^Optional

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

For VPC network only.

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/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.