Skip to content

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

Name Type Description
addressIpVersion string | @alicloud/ros-cdk-core.IResolvable Property addressIpVersion: IP version, support 'ipv4' or 'ipv6'.
addressType string | @alicloud/ros-cdk-core.IResolvable Property addressType: The network type of the CLB instance.
bandwidth number | @alicloud/ros-cdk-core.IResolvable Property bandwidth: The bandwidth for network, unit in Mbps(Mega bit per second).
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Whether to enable deletion protection.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: Instance billing method.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: The metering method of the Internet-facing CLB instance.
loadBalancerName string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerName: Name of created load balancer.
loadBalancerSpec string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerSpec: The specification of the CLB instance.
masterZoneId string | @alicloud/ros-cdk-core.IResolvable Property masterZoneId: The master zone id to create load balancer instance.
modificationProtectionReason string | @alicloud/ros-cdk-core.IResolvable Property modificationProtectionReason: Set the reason for modifying the protection status.
modificationProtectionStatus string | @alicloud/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.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
slaveZoneId string | @alicloud/ros-cdk-core.IResolvable Property slaveZoneId: The slave zone id to create load balancer instance.
tags TagsProperty[] Property tags: Tags to attach to slb.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC id to create load balancer instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The VSwitch id to create load balancer instance.

addressIpVersionOptional 

public readonly addressIpVersion: string | IResolvable;
  • Type: string | @alicloud/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 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.

bandwidthOptional 

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.

deletionProtectionOptional 

public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: Instance billing method.

Valid value: - PayBySpec (default): Pay by spec. - PayByCLCU: billed by usage.

internetChargeTypeOptional 

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.

loadBalancerNameOptional 

public readonly loadBalancerName: string | IResolvable;
  • Type: string | @alicloud/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 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 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 readonly masterZoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

modificationProtectionReasonOptional 

public readonly modificationProtectionReason: string | IResolvable;
  • Type: string | @alicloud/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 readonly modificationProtectionStatus: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

slaveZoneIdOptional 

public readonly slaveZoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

tagsOptional 

public readonly tags: 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.

vpcIdOptional 

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.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

For VPC network only.