Skip to content

LoadBalancer

This class encapsulates and extends the ROS resource type ALIYUN::ALB::LoadBalancer, which is used to create an Application Load Balancer (ALB) instance.

Initializers 

import ros_cdk_alb
ros_cdk_alb.LoadBalancer(
  scope: Construct,
  id: str,
  address_type: typing.Union[str, IResolvable],
  load_balancer_billing_config: typing.Union[IResolvable, LoadBalancerBillingConfigProperty],
  load_balancer_edition: typing.Union[str, IResolvable],
  load_balancer_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  zone_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneMappingsProperty]]],
  access_log_config: typing.Union[IResolvable, AccessLogConfigProperty] = None,
  address_allocated_mode: typing.Union[str, IResolvable] = None,
  address_ip_version: typing.Union[str, IResolvable] = None,
  bandwidth_package_id: typing.Union[str, IResolvable] = None,
  deletion_protection_enabled: typing.Union[bool, IResolvable] = None,
  modification_protection_config: typing.Union[IResolvable, ModificationProtectionConfigProperty] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
address_type typing.Union[str, ros_cdk_core.IResolvable] Property addressType: The type of IP address that the ALB instance uses to provide services.
load_balancer_billing_config typing.Union[ros_cdk_core.IResolvable, LoadBalancerBillingConfigProperty] Property loadBalancerBillingConfig: The configuration of the billing method.
load_balancer_edition typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerEdition: The edition of the ALB instance.
load_balancer_name typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerName: The name of the ALB instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC) where the ALB 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.
access_log_config typing.Union[ros_cdk_core.IResolvable, AccessLogConfigProperty] Property accessLogConfig:.
address_allocated_mode typing.Union[str, ros_cdk_core.IResolvable] Property addressAllocatedMode: The mode in which IP addresses are assigned.
address_ip_version typing.Union[str, ros_cdk_core.IResolvable] Property addressIpVersion: The protocol version.
bandwidth_package_id typing.Union[str, ros_cdk_core.IResolvable] Property bandwidthPackageId: Attach common bandwidth package to load balancer.
deletion_protection_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtectionEnabled: Specifies whether to enable deletion protection.
modification_protection_config typing.Union[ros_cdk_core.IResolvable, ModificationProtectionConfigProperty] Property modificationProtectionConfig: The configuration of modification protection.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
security_group_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityGroupIds: The IDs of the security group to which the ALB instance join.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

address_typeRequired

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

load_balancer_billing_configRequired

Property loadBalancerBillingConfig: The configuration of the billing method.

load_balancer_editionRequired

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

load_balancer_nameRequired

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

Property loadBalancerName: The name of the ALB 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.

vpc_idRequired

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

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

zone_mappingsRequired

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

access_log_configOptional

Property accessLogConfig:.

address_allocated_modeOptional

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

Property addressAllocatedMode: The mode in which IP addresses are assigned.

Valid values: Fixed: The ALB instance uses a static IP address. Dynamic: An IP address is dynamically assigned to the ALB instance in each zone. This is the default value.

address_ip_versionOptional

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

Property addressIpVersion: The protocol version.

Valid values: IPv4: IPv4 DualStack: dual stack

bandwidth_package_idOptional

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

Property bandwidthPackageId: Attach common bandwidth package to load balancer.

It only takes effect when AddressType=Internet.

deletion_protection_enabledOptional

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

Property deletionProtectionEnabled: Specifies whether to enable deletion protection.

Default value: false.

modification_protection_configOptional

Property modificationProtectionConfig: The configuration of modification protection.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.

security_group_idsOptional

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

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

tagsOptional

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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_alb
ros_cdk_alb.LoadBalancer.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_address_type ros_cdk_core.IResolvable Attribute AddressType: The type of IP address that the ALB instance uses to provide services.
attr_dns_name ros_cdk_core.IResolvable Attribute DNSName: The domain name of the ALB instance.
attr_load_balancer_edition ros_cdk_core.IResolvable Attribute LoadBalancerEdition: The edition of the ALB instance.
attr_load_balancer_id ros_cdk_core.IResolvable Attribute LoadBalancerId: The ID of the ALB instance.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC) where the ALB instance is deployed.
attr_zone_mappings ros_cdk_core.IResolvable Attribute ZoneMappings: The zones, vSwitches and addresses which are mapped to the zones.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_address_typeRequired 

attr_address_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AddressType: The type of IP address that the ALB instance uses to provide services.

attr_dns_nameRequired 

attr_dns_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DNSName: The domain name of the ALB instance.

attr_load_balancer_editionRequired 

attr_load_balancer_edition: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerEdition: The edition of the ALB instance.

attr_load_balancer_idRequired 

attr_load_balancer_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerId: The ID of the ALB instance.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The ID of the virtual private cloud (VPC) where the ALB instance is deployed.

attr_zone_mappingsRequired 

attr_zone_mappings: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneMappings: The zones, vSwitches and addresses which are mapped to the zones.