Skip to content

LoadBalancerProps

Properties for defining a LoadBalancer.

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

Initializer 

import ros_cdk_nlb
ros_cdk_nlb.LoadBalancerProps(
  address_type: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  zone_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneMappingsProperty]]],
  address_ip_version: typing.Union[str, IResolvable] = None,
  bandwidth_package_id: typing.Union[str, IResolvable] = None,
  cross_zone_enabled: typing.Union[bool, IResolvable] = None,
  deletion_protection_config: typing.Union[IResolvable, DeletionProtectionConfigProperty] = None,
  load_balancer_billing_config: typing.Union[IResolvable, LoadBalancerBillingConfigProperty] = None,
  load_balancer_name: typing.Union[str, IResolvable] = None,
  load_balancer_type: typing.Union[str, IResolvable] = None,
  modification_protection_config: typing.Union[IResolvable, ModificationProtectionConfigProperty] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  traffic_affinity_enabled: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
address_type typing.Union[str, ros_cdk_core.IResolvable] Property addressType: The type of IP address that the NLB instance uses to provide services.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC) where the NLB instance is deployed.
zone_mappings typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneMappingsProperty]]] Property zoneMappings: The zones and the vSwitches in the zones.
address_ip_version typing.Union[str, ros_cdk_core.IResolvable] Property addressIpVersion: The version of IP address that the NLB instance uses to provide services.
bandwidth_package_id typing.Union[str, ros_cdk_core.IResolvable] Property bandwidthPackageId: Attach common bandwidth package to load balancer.
cross_zone_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property crossZoneEnabled: Whether enable cross zone.
deletion_protection_config typing.Union[ros_cdk_core.IResolvable, DeletionProtectionConfigProperty] Property deletionProtectionConfig: The configuration of the deletion protection feature.
load_balancer_billing_config typing.Union[ros_cdk_core.IResolvable, LoadBalancerBillingConfigProperty] Property loadBalancerBillingConfig: The configuration of the billing method.
load_balancer_name typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerName: The name of the NLB instance.
load_balancer_type typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerType: The type of the NLB instance.
modification_protection_config typing.Union[ros_cdk_core.IResolvable, ModificationProtectionConfigProperty] Property modificationProtectionConfig: The configuration of the configuration read-only mode.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
traffic_affinity_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property trafficAffinityEnabled: Whether enable traffic affinity.

address_typeRequired 

address_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property addressType: The type of IP address that the NLB instance uses to provide services.

Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. Therefore, the NLB instance can be accessed over the VPC where the NLB instance is deployed.

vpc_idRequired 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the virtual private cloud (VPC) where the NLB instance is deployed.

zone_mappingsRequired 

zone_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneMappingsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneMappingsProperty]]]

Property zoneMappings: The zones and the vSwitches in the zones.

You must specify at least two zones.

address_ip_versionOptional 

address_ip_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property addressIpVersion: The version of IP address that the NLB instance uses to provide services.

bandwidth_package_idOptional 

bandwidth_package_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property bandwidthPackageId: Attach common bandwidth package to load balancer.

cross_zone_enabledOptional 

cross_zone_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property crossZoneEnabled: Whether enable cross zone.

Default: true

deletion_protection_configOptional 

deletion_protection_config: typing.Union[IResolvable, DeletionProtectionConfigProperty]

Property deletionProtectionConfig: The configuration of the deletion protection feature.

load_balancer_billing_configOptional 

load_balancer_billing_config: typing.Union[IResolvable, LoadBalancerBillingConfigProperty]

Property loadBalancerBillingConfig: The configuration of the billing method.

load_balancer_nameOptional 

load_balancer_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property loadBalancerName: The name of the NLB instance.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods(.), underscores (_), and hyphens (-). The name must start with a letter.

load_balancer_typeOptional 

load_balancer_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property loadBalancerType: The type of the NLB instance.

modification_protection_configOptional 

modification_protection_config: typing.Union[IResolvable, ModificationProtectionConfigProperty]

Property modificationProtectionConfig: The configuration of the configuration read-only mode.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

traffic_affinity_enabledOptional 

traffic_affinity_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property trafficAffinityEnabled: Whether enable traffic affinity.

Default: false