Skip to content

LoadBalancer

This class encapsulates and extends the ROS resource type DATASOURCE::SLB::LoadBalancer.

Initializers

from ros_cdk_slb import datasource
datasource.LoadBalancer(
  scope: Construct,
  id: str,
  load_balancer_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerId: The CLB instance ID.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

load_balancer_idRequired

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

Property loadBalancerId: The CLB instance ID.


refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

from ros_cdk_slb import datasource
datasource.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 ros_cdk_core.IResolvable Attribute Address: The service IP address of the CLB instance.
attr_address_ip_version ros_cdk_core.IResolvable Attribute AddressIpVersion: The version of the IP address.
attr_address_type ros_cdk_core.IResolvable Attribute AddressType: The address type of the CLB instance.
attr_auto_release_time ros_cdk_core.IResolvable Attribute AutoReleaseTime: The timestamp generated when the CLB instance is released.
attr_backend_servers ros_cdk_core.IResolvable Attribute BackendServers: The backend servers of the CLB instance.
attr_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: The maximum bandwidth of the Internet-facing CLB instance that is billed on a pay-by-bandwidth basis.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the CLB instance was created.
attr_create_time_stamp ros_cdk_core.IResolvable Attribute CreateTimeStamp: The timestamp generated when the CA certificate is uploaded.
attr_delete_protection ros_cdk_core.IResolvable Attribute DeleteProtection: Indicates whether deletion protection is enabled for the CLB instance.
attr_end_time ros_cdk_core.IResolvable Attribute EndTime: The time when the CLB instance expires.
attr_end_time_stamp ros_cdk_core.IResolvable Attribute EndTimeStamp: The timestamp that indicates the expiration time of the CLB instance.
attr_instance_charge_type ros_cdk_core.IResolvable Attribute InstanceChargeType: Instance billing method.
attr_internet_charge_type ros_cdk_core.IResolvable Attribute InternetChargeType: The metering method of the Internet-facing CLB instance.
attr_listener_ports_and_protocal ros_cdk_core.IResolvable Attribute ListenerPortsAndProtocal: The ports or protocols of the listeners.
attr_listener_ports_and_protocol ros_cdk_core.IResolvable Attribute ListenerPortsAndProtocol: The ports or protocols of the listeners.
attr_load_balancer_id ros_cdk_core.IResolvable Attribute LoadBalancerId: The CLB instance ID.
attr_load_balancer_name ros_cdk_core.IResolvable Attribute LoadBalancerName: The name of the CLB instance.
attr_load_balancer_spec ros_cdk_core.IResolvable Attribute LoadBalancerSpec: The specification of the CLB instance.
attr_master_zone_id ros_cdk_core.IResolvable Attribute MasterZoneId: The ID of the primary zone to which the CLB instance belongs.
attr_modification_protection_reason ros_cdk_core.IResolvable Attribute ModificationProtectionReason: The reason why the configuration read-only mode is enabled.
attr_modification_protection_status ros_cdk_core.IResolvable Attribute ModificationProtectionStatus: Load balancing modifies the protection state.
attr_network_type ros_cdk_core.IResolvable Attribute NetworkType: The network type of the CLB instance.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Load balancing instance payment type.
attr_region_id_alias ros_cdk_core.IResolvable Attribute RegionIdAlias: The alias of the region to which the CLB instance belongs.
attr_renewal_cyc_unit ros_cdk_core.IResolvable Attribute RenewalCycUnit: The auto-renewal cycle.
attr_renewal_duration ros_cdk_core.IResolvable Attribute RenewalDuration: The auto-renewal duration.
attr_renewal_status ros_cdk_core.IResolvable Attribute RenewalStatus: Indicates whether auto-renewal is enabled.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The resource group ID.
attr_slave_zone_id ros_cdk_core.IResolvable Attribute SlaveZoneId: The ID of the secondary zone to which the CLB instance belongs.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags of the CLB instance.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC) where the internal-facing CLB instance is deployed.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the internal-facing CLB instance belongs.

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_addressRequired

attr_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Address: The service IP address of the CLB instance.


attr_address_ip_versionRequired

attr_address_ip_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AddressIpVersion: The version of the IP address.

Valid values: ipv4 and ipv6.


attr_address_typeRequired

attr_address_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AddressType: The address type of the CLB instance.


attr_auto_release_timeRequired

attr_auto_release_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoReleaseTime: The timestamp generated when the CLB instance is released.


attr_backend_serversRequired

attr_backend_servers: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackendServers: The backend servers of the CLB instance.


attr_bandwidthRequired

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The maximum bandwidth of the Internet-facing CLB instance that is billed on a pay-by-bandwidth basis.


attr_create_timeRequired

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the CLB instance was created.


attr_create_time_stampRequired

attr_create_time_stamp: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTimeStamp: The timestamp generated when the CA certificate is uploaded.


attr_delete_protectionRequired

attr_delete_protection: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DeleteProtection: Indicates whether deletion protection is enabled for the CLB instance.


attr_end_timeRequired

attr_end_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndTime: The time when the CLB instance expires.


attr_end_time_stampRequired

attr_end_time_stamp: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndTimeStamp: The timestamp that indicates the expiration time of the CLB instance.


attr_instance_charge_typeRequired

attr_instance_charge_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceChargeType: Instance billing method.


attr_internet_charge_typeRequired

attr_internet_charge_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetChargeType: The metering method of the Internet-facing CLB instance.


attr_listener_ports_and_protocalRequired

attr_listener_ports_and_protocal: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ListenerPortsAndProtocal: The ports or protocols of the listeners.


attr_listener_ports_and_protocolRequired

attr_listener_ports_and_protocol: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ListenerPortsAndProtocol: The ports or protocols of the listeners.


attr_load_balancer_idRequired

attr_load_balancer_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerId: The CLB instance ID.


attr_load_balancer_nameRequired

attr_load_balancer_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerName: The name of the CLB instance.


attr_load_balancer_specRequired

attr_load_balancer_spec: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerSpec: The specification of the CLB instance.


attr_master_zone_idRequired

attr_master_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterZoneId: The ID of the primary zone to which the CLB instance belongs.


attr_modification_protection_reasonRequired

attr_modification_protection_reason: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ModificationProtectionReason: The reason why the configuration read-only mode is enabled.


attr_modification_protection_statusRequired

attr_modification_protection_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ModificationProtectionStatus: Load balancing modifies the protection state.


attr_network_typeRequired

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkType: The network type of the CLB instance.


attr_payment_typeRequired

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Load balancing instance payment type.


attr_region_id_aliasRequired

attr_region_id_alias: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RegionIdAlias: The alias of the region to which the CLB instance belongs.


attr_renewal_cyc_unitRequired

attr_renewal_cyc_unit: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RenewalCycUnit: The auto-renewal cycle.

Valid values: Year and Month. Default value: Month.


attr_renewal_durationRequired

attr_renewal_duration: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RenewalDuration: The auto-renewal duration.

This parameter is valid only if RenewalStatus is set to AutoRenewal.


attr_renewal_statusRequired

attr_renewal_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RenewalStatus: Indicates whether auto-renewal is enabled.


attr_resource_group_idRequired

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The resource group ID.


attr_slave_zone_idRequired

attr_slave_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SlaveZoneId: The ID of the secondary zone to which the CLB instance belongs.


attr_tagsRequired

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the CLB 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 internal-facing CLB instance is deployed.


attr_v_switch_idRequired

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The ID of the vSwitch to which the internal-facing CLB instance belongs.