Skip to content

LoadBalancerProps

Properties for defining a LoadBalancer.

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

Initializer

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

Properties

Name Type Description
addressType string | @alicloud/ros-cdk-core.IResolvable Property addressType: The type of IP address that the ALB instance uses to provide services.
loadBalancerBillingConfig @alicloud/ros-cdk-core.IResolvable | LoadBalancerBillingConfigProperty Property loadBalancerBillingConfig: The configuration of the billing method.
loadBalancerEdition string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerEdition: The edition of the ALB instance.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC) where the ALB 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.
accessLogConfig @alicloud/ros-cdk-core.IResolvable | AccessLogConfigProperty Property accessLogConfig:.
addressAllocatedMode string | @alicloud/ros-cdk-core.IResolvable Property addressAllocatedMode: Address allocation mode.
addressIpVersion string | @alicloud/ros-cdk-core.IResolvable Property addressIpVersion: The protocol version.
bandwidthPackageId string | @alicloud/ros-cdk-core.IResolvable Property bandwidthPackageId: Attach common bandwidth package to load balancer.
deletionProtectionEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtectionEnabled: Specifies whether to enable deletion protection.
ipv6AddressType string | @alicloud/ros-cdk-core.IResolvable Property ipv6AddressType: The type of IPv6 address that the ALB instance uses to provide services.
loadBalancerName string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerName: The name of the Application Load Balancer (ALB) instance.
modificationProtectionConfig @alicloud/ros-cdk-core.IResolvable | ModificationProtectionConfigProperty Property modificationProtectionConfig: The modification protection configuration.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
securityGroupIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property securityGroupIds: The IDs of the security group to which the ALB instance join.
tags TagsProperty[] Property tags: Tags to attach to instance.

addressTypeRequired

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

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

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


loadBalancerBillingConfigRequired

public readonly loadBalancerBillingConfig: IResolvable | LoadBalancerBillingConfigProperty;

Property loadBalancerBillingConfig: The configuration of the billing method.


loadBalancerEditionRequired

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

Property loadBalancerEdition: The edition of the ALB instance.

Different editions have different limits and billing methods. Valid values: Basic: Basic Edition Standard: Standard Edition StandardWithWaf: Standard Edition with WAF


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


accessLogConfigOptional

public readonly accessLogConfig: IResolvable | AccessLogConfigProperty;

Property accessLogConfig:.


addressAllocatedModeOptional

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

Property addressAllocatedMode: Address allocation mode.

Valid values: - Fixed (Default): A fixed IP address is allocated to each zone. - Dynamic: Dynamic IP mode. IP addresses are dynamically allocated for each zone.

Starting from , when you create a new instance by using this interface, it is created as an upgraded ALB instance regardless of the mode you specify. The distinction between IP modes is removed, and the allocated IP addresses are automatically elastic. ALB instances created before the upgrade are not affected.


addressIpVersionOptional

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

Property addressIpVersion: The protocol version.

Valid values: IPv4: IPv4 DualStack: dual stack


bandwidthPackageIdOptional

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

Property bandwidthPackageId: Attach common bandwidth package to load balancer.

It only takes effect when AddressType=Internet.


deletionProtectionEnabledOptional

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

Property deletionProtectionEnabled: Specifies whether to enable deletion protection.

Default value: false.


ipv6AddressTypeOptional

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

Property ipv6AddressType: The type of IPv6 address that the ALB instance uses to provide services.

Valid values: Internet: The ALB instance uses a public IPv6 address. The domain name of the ALB instance is resolved to the public IPv6 address. Intranet: The ALB instance uses a private IPv6 address. The domain name of the ALB instance is resolved to the private IP address.


loadBalancerNameOptional

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

Property loadBalancerName: The name of the Application Load Balancer (ALB) instance.

The name must be 2 to 128 characters long, must start with a letter, digit, or Chinese character, and can contain digits, periods (.), underscores (_), hyphens (-), and spaces.


modificationProtectionConfigOptional

public readonly modificationProtectionConfig: IResolvable | ModificationProtectionConfigProperty;

Property modificationProtectionConfig: The modification protection configuration.


resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.


securityGroupIdsOptional

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

Property securityGroupIds: The IDs of the security group to which the ALB instance join.


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.