Skip to content

LoadBalancerProps

Properties for defining a LoadBalancer.

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

Initializer 

import { LoadBalancerProps } from '@alicloud/ros-cdk-nlb'
const loadBalancerProps: LoadBalancerProps = { ... }

Properties

Name Type Description
addressType string | @alicloud/ros-cdk-core.IResolvable Property addressType: The type of IP address that the NLB instance uses to provide services.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC) where the NLB instance is deployed.
zoneMappings @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ZoneMappingsProperty[] Property zoneMappings: The zones and the vSwitches in the zones.
addressIpVersion string | @alicloud/ros-cdk-core.IResolvable Property addressIpVersion: The version of IP address that the NLB instance uses to provide services.
bandwidthPackageId string | @alicloud/ros-cdk-core.IResolvable Property bandwidthPackageId: Attach common bandwidth package to load balancer.
crossZoneEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property crossZoneEnabled: Whether enable cross zone.
deletionProtectionConfig @alicloud/ros-cdk-core.IResolvable | DeletionProtectionConfigProperty Property deletionProtectionConfig: The configuration of the deletion protection feature.
loadBalancerBillingConfig @alicloud/ros-cdk-core.IResolvable | LoadBalancerBillingConfigProperty Property loadBalancerBillingConfig: The configuration of the billing method.
loadBalancerName string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerName: The name of the NLB instance.
loadBalancerType string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerType: The type of the NLB instance.
modificationProtectionConfig @alicloud/ros-cdk-core.IResolvable | ModificationProtectionConfigProperty Property modificationProtectionConfig: The configuration of the configuration read-only mode.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags to attach to instance.
trafficAffinityEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property trafficAffinityEnabled: Whether enable traffic affinity.

addressTypeRequired 

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

vpcIdRequired 

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

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

zoneMappingsRequired 

public readonly zoneMappings: IResolvable | IResolvable | ZoneMappingsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ZoneMappingsProperty[]

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

You must specify at least two zones.

addressIpVersionOptional 

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

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

bandwidthPackageIdOptional 

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

Property bandwidthPackageId: Attach common bandwidth package to load balancer.

crossZoneEnabledOptional 

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

Property crossZoneEnabled: Whether enable cross zone.

Default: true

deletionProtectionConfigOptional 

public readonly deletionProtectionConfig: IResolvable | DeletionProtectionConfigProperty;

Property deletionProtectionConfig: The configuration of the deletion protection feature.

loadBalancerBillingConfigOptional 

public readonly loadBalancerBillingConfig: IResolvable | LoadBalancerBillingConfigProperty;

Property loadBalancerBillingConfig: The configuration of the billing method.

loadBalancerNameOptional 

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

loadBalancerTypeOptional 

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

Property loadBalancerType: The type of the NLB instance.

modificationProtectionConfigOptional 

public readonly modificationProtectionConfig: IResolvable | ModificationProtectionConfigProperty;

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

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

tagsOptional 

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

trafficAffinityEnabledOptional 

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

Property trafficAffinityEnabled: Whether enable traffic affinity.

Default: false