Skip to content

LoadBalancerProps

Properties for defining a LoadBalancer.

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

Initializer 

import com.aliyun.ros.cdk.slb.LoadBalancerProps;
LoadBalancerProps.builder()
//  .addressIpVersion(java.lang.String)
//  .addressIpVersion(IResolvable)
//  .addressType(java.lang.String)
//  .addressType(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .duration(java.lang.Number)
//  .duration(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)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(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();

Properties

Name Type Description
addressIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property addressIpVersion: IP version, support 'ipv4' or 'ipv6'.
addressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property addressType: The network type of the CLB instance.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Specifies whether to automatically pay for the subscription Internet-facing CLB instance.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Indicates whether automatic renewal is enabled for the instance.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: Automatic renewal cycle, which takes effect when AutoRenew is true, and is required: When PricingCycle = month, the value range is 1 to 9 or 12, 24, 36.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: The bandwidth for network, unit in Mbps(Mega bit per second).
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Whether to enable deletion protection.
duration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property duration: Optional.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: Instance billing method.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: The metering method of the Internet-facing CLB instance.
loadBalancerName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerName: Name of created load balancer.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerSpec: The specification of the CLB instance.
masterZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property masterZoneId: The master zone id to create load balancer instance.
modificationProtectionReason java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property modificationProtectionReason: Set the reason for modifying the protection status.
modificationProtectionStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property modificationProtectionStatus: NonProtection or empty: means no restriction on modification protection ConsoleProtection: Modify instance protection status by console Default value is empty.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: Optional.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pricingCycle: Optional.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
slaveZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property slaveZoneId: The slave zone id to create load balancer instance.
tags java.util.List<TagsProperty> Property tags: Tags to attach to slb.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id to create load balancer instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The VSwitch id to create load balancer instance.

addressIpVersionOptional 

public java.lang.Object getAddressIpVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property addressIpVersion: IP version, support 'ipv4' or 'ipv6'.

If 'ipv6' is selected, please note that the zone and the specification are supported.

addressTypeOptional 

public java.lang.Object getAddressType();
  • 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.

autoPayOptional 

public java.lang.Object getAutoPay();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Specifies whether to automatically pay for the subscription Internet-facing CLB instance.

Valid values:

  • true: automatically pays for the CLB instance. After you call this operation, the system automatically completes the payment and creates the CLB instance.- false (default): After you call the operation, the order is created but the payment is not completed. You can view the pending order in the console. The CLB instance will not be created until you complete the payment.Note This parameter is supported only by subscription instances created on the Alibaba Cloud China site.

autoRenewOptional 

public java.lang.Object getAutoRenew();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Indicates whether automatic renewal is enabled for the instance.

Valid values:- true: Automatic renewal is enabled.- false (default): Automatic renewal is not enabled. You must renew the instance manually.

autoRenewPeriodOptional 

public java.lang.Object getAutoRenewPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: Automatic renewal cycle, which takes effect when AutoRenew is true, and is required: When PricingCycle = month, the value range is 1 to 9 or 12, 24, 36.

When PeriodUnit = year, the value range is 1-3.

bandwidthOptional 

public java.lang.Object getBandwidth();
  • 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.

deletionProtectionOptional 

public java.lang.Object getDeletionProtection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

durationOptional 

public java.lang.Object getDuration();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property duration: Optional.

The subscription duration of a Subscription Internet instance. Valid values: If PricingCycle is month, the valid range is 1 to 9 or 12, 24, 36, 48, 60. If PricingCycle is year, the value range is 1 to 5.

instanceChargeTypeOptional 

public java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: Instance billing method.

Valid value:

  • PayBySpec (default): Pay by spec.
  • PayByCLCU: billed by usage.

internetChargeTypeOptional 

public java.lang.Object getInternetChargeType();
  • 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.

loadBalancerNameOptional 

public java.lang.Object getLoadBalancerName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loadBalancerName: Name of created load balancer.

Length is limited to 1-80 characters, allowed to contain letters, numbers, '-, /, _,.' When not specified, a default name will be assigned.

loadBalancerSpecOptional 

public java.lang.Object getLoadBalancerSpec();
  • 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 Note If you do not specify this parameter, a shared-resource CLB instance is created. Shared-resource CLB instances are no longer available for purchase. Therefore, you must specify this parameter. If InstanceChargeType is set to PayByCLCU, this parameter is invalid and you do not need to specify this parameter.

masterZoneIdOptional 

public java.lang.Object getMasterZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

modificationProtectionReasonOptional 

public java.lang.Object getModificationProtectionReason();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property modificationProtectionReason: Set the reason for modifying the protection status.

The length is 1-80 English or Chinese characters, must start with upper and lower letters or Chinese, and can include numbers, periods (.), underscores (_) and dashes (-). Only valid when ModificationProtectionStatus is ConsoleProtection.

modificationProtectionStatusOptional 

public java.lang.Object getModificationProtectionStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property modificationProtectionStatus: NonProtection or empty: means no restriction on modification protection ConsoleProtection: Modify instance protection status by console Default value is empty.

payTypeOptional 

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: Optional.

The billing method of the instance to be created. Valid value: PayOnDemand (Pay-As-You-Go) | PrePay (Subscription)

pricingCycleOptional 

public java.lang.Object getPricingCycle();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property pricingCycle: Optional.

The duration of the Subscription-billed Internet instance to be created. Valid values: month | year.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

slaveZoneIdOptional 

public java.lang.Object getSlaveZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

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.

vpcIdOptional 

public java.lang.Object getVpcId();
  • 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.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The VSwitch id to create load balancer instance.

For VPC network only.