LoadBalancer

• Implements: ILoadBalancer

This class encapsulates and extends the ROS resource type ALIYUN::ALB::LoadBalancerThe , which type 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],
  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,
  ipv6_address_type: typing.Union[str, IResolvable] = None,
  load_balancer_name: typing.Union[str, 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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

address_type^Required

• 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_config^Required

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

Property loadBalancerBillingConfig: The configuration of the billing method.

load_balancer_edition^Required

• 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

vpc_id^Required

• 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_mappings^Required

• 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_config^Optional

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

Property accessLogConfig:.

address_allocated_mode^Optional

• 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_version^Optional

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

Property addressIpVersion: The protocol version.

Valid values: IPv4: IPv4 DualStack: dual stack

bandwidth_package_id^Optional

• 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_enabled^Optional

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

Property deletionProtectionEnabled: Specifies whether to enable deletion protection.

Default value: false.

ipv6_address_type^Optional

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

load_balancer_name^Optional

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

modification_protection_config^Optional

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

Property modificationProtectionConfig: The configuration of modification protection.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

security_group_ids^Optional

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

tags^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_address_type^Required

attr_address_type: typing.Union[str, IResolvable]

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

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

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_dns_name^Required

attr_dns_name: typing.Union[str, IResolvable]

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

Attribute DNSName: The domain name of the ALB instance.

attr_load_balancer_edition^Required

attr_load_balancer_edition: typing.Union[str, IResolvable]

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

Attribute LoadBalancerEdition: The edition of the ALB instance.

attr_load_balancer_id^Required

attr_load_balancer_id: typing.Union[str, IResolvable]

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

Attribute LoadBalancerId: The ID of the ALB instance.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

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

attr_zone_mappings^Required

attr_zone_mappings: typing.Union[str, IResolvable]

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

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

props^Required

props: LoadBalancerProps

• Type: LoadBalancerProps