LoadBalancer

• Implements: ILoadBalancer

This class encapsulates and extends the ROS resource type ALIYUN::SLB::LoadBalancerUse the , which resource type to create an SLB instance.

Initializers

import com.aliyun.ros.cdk.slb.LoadBalancer;
LoadBalancer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .addressIpVersion(java.lang.String)
//  .addressIpVersion(IResolvable)
//  .addressType(java.lang.String)
//  .addressType(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .loadBalancerName(java.lang.String)
//  .loadBalancerName(IResolvable)
//  .loadBalancerSpec(java.lang.String)
//  .loadBalancerSpec(IResolvable)
//  .masterZoneId(java.lang.String)
//  .masterZoneId(IResolvable)
//  .modificationProtectionReason(java.lang.String)
//  .modificationProtectionReason(IResolvable)
//  .modificationProtectionStatus(java.lang.String)
//  .modificationProtectionStatus(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .slaveZoneId(java.lang.String)
//  .slaveZoneId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

addressIpVersion^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property addressIpVersion: The IP version of the CLB instance.

Valid values: ipv4 and ipv6.

addressType^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

instanceChargeType^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

modificationProtectionReason^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

slaveZoneId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

tags^Optional

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

vpcId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

For VPC network only.

vSwitchId^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.slb.LoadBalancer;
LoadBalancer.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAddressIpVersion^Required

public java.lang.Object getAttrAddressIpVersion();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AddressIPVersion: IP version.

attrAddressType^Required

public java.lang.Object getAttrAddressType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AddressType: The address type of the load balancer.

"intranet" or "internet".

attrBandwidth^Required

public java.lang.Object getAttrBandwidth();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: The bandwidth for network.

attrIpAddress^Required

public java.lang.Object getAttrIpAddress();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IpAddress: The ip address of the load balancer.

attrLoadBalancerId^Required

public java.lang.Object getAttrLoadBalancerId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancerId: The id of load balance created.

attrLoadBalancerName^Required

public java.lang.Object getAttrLoadBalancerName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancerName: Name of created load balancer.

attrLoadBalancerSpec^Required

public java.lang.Object getAttrLoadBalancerSpec();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancerSpec: The specification of the Server Load Balancer instance.

attrMasterZoneId^Required

public java.lang.Object getAttrMasterZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MasterZoneId: The master zone id to create load balancer instance.

attrNetworkType^Required

public java.lang.Object getAttrNetworkType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkType: The network type of the load balancer.

"vpc" or "classic" network.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The order ID.

attrPayType^Required

public java.lang.Object getAttrPayType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PayType: The billing method of the instance to be created.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: Resource group id.

attrSlaveZoneId^Required

public java.lang.Object getAttrSlaveZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SlaveZoneId: The slave zone id to create load balancer instance.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: Vpc id.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: VSwitch id.

props^Required

public LoadBalancerProps getProps();

• Type: LoadBalancerProps