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: IP version, support 'ipv4' or 'ipv6'.
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: Instance billing method.
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: Name of created load balancer.
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: Set the reason for modifying the protection status.
modification_protection_status typing.Union[str, 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.
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 VSwitch id to create load balancer instance.

address_ip_versionOptional

address_ip_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


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: Instance billing method.

Valid value:

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

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


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 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.

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


modification_protection_statusOptional

modification_protection_status: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


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 VSwitch id to create load balancer instance.

For VPC network only.