Skip to content

RosLoadBalancer

This class is a base encapsulation around the ROS resource type ALIYUN::SLB::LoadBalancer, which is used to create a Server Load Balancer (SLB) instance.

Initializers

import ros_cdk_slb
ros_cdk_slb.RosLoadBalancer(
  scope: Construct,
  id: str,
  address_ip_version: typing.Union[str, IResolvable] = None,
  address_type: typing.Union[str, IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  load_balancer_name: typing.Union[str, IResolvable] = None,
  load_balancer_spec: typing.Union[str, IResolvable] = None,
  master_zone_id: typing.Union[str, IResolvable] = None,
  modification_protection_reason: typing.Union[str, IResolvable] = None,
  modification_protection_status: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  slave_zone_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool
)
Name Type Description
scope ros_cdk_core.Construct - scope in which this resource is defined.
id str - scoped id of the resource.
address_ip_version typing.Union[str, ros_cdk_core.IResolvable] No description.
address_type typing.Union[str, ros_cdk_core.IResolvable] No description.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] No description.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
load_balancer_name typing.Union[str, ros_cdk_core.IResolvable] No description.
load_balancer_spec typing.Union[str, ros_cdk_core.IResolvable] No description.
master_zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.
modification_protection_reason typing.Union[str, ros_cdk_core.IResolvable] No description.
modification_protection_status typing.Union[str, ros_cdk_core.IResolvable] No description.
pay_type typing.Union[str, ros_cdk_core.IResolvable] No description.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] No description.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
slave_zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.
tags typing.List[TagsProperty] No description.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] No description.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] No description.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

scope in which this resource is defined.


idRequired

  • Type: str

scoped id of the resource.


address_ip_versionOptional

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

address_typeOptional

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

auto_payOptional

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

auto_renewOptional

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

auto_renew_periodOptional

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

bandwidthOptional

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

deletion_protectionOptional

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

durationOptional

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

instance_charge_typeOptional

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

internet_charge_typeOptional

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

load_balancer_nameOptional

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

load_balancer_specOptional

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

master_zone_idOptional

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

modification_protection_reasonOptional

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

modification_protection_statusOptional

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

pay_typeOptional

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

pricing_cycleOptional

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

resource_group_idOptional

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

slave_zone_idOptional

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

tagsOptional


vpc_idOptional

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

v_switch_idOptional

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

enable_resource_property_constraintRequired

  • 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.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
add_condition No description.
add_count No description.
add_deletion_override Syntactic sugar for addOverride(path, undefined).
add_depends_on Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
add_desc No description.
add_meta_data No description.
add_override Adds an override to the synthesized ROS resource.
add_property_deletion_override Adds an override that deletes the value of a property from the resource definition.
add_property_override Adds an override to a resource property.
add_ros_dependency No description.
apply_removal_policy Sets the deletion policy of the resource based on the removal policy specified.
get_att Returns a token for an runtime attribute of this resource.

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.


override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired

  • Type: str

The new logical ID to use for this stack element.


add_condition

def add_condition(
  con: RosCondition
) -> None

conRequired

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

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: str

The path of the value to delete.


add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

  • Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

descRequired

  • Type: str

add_meta_data

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: typing.Any

The value.

Could be primitive or complex.


add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_pathRequired

  • Type: str

The path to the property.


add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_pathRequired

  • Type: str

The path of the property.


valueRequired

  • Type: typing.Any

The value.


add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

targetRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

  • Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policyOptional

  • Type: bool

default_policyOptional

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_nameRequired

  • Type: str

The name of the attribute.


Static Functions

Name Description
is_construct Return whether the given object is a Construct.
is_ros_element Returns true if a construct is a stack element (i.e. part of the synthesized template).
is_ros_resource Check whether the given construct is a RosResource.

is_construct

import ros_cdk_slb
ros_cdk_slb.RosLoadBalancer.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

is_ros_element

import ros_cdk_slb
ros_cdk_slb.RosLoadBalancer.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: typing.Any

is_ros_resource

import ros_cdk_slb
ros_cdk_slb.RosLoadBalancer.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

constructRequired

  • Type: ros_cdk_core.IConstruct

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
creation_stack typing.List[str] No description.
logical_id str The logical ID for this stack element.
stack ros_cdk_core.Stack The stack in which this element is defined.
ref str Return a string that will be resolved to a RosTemplate { Ref } for this element.
ros_options ros_cdk_core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
ros_resource_type str ROS resource type.
attr_address_ip_version ros_cdk_core.IResolvable No description.
attr_address_type ros_cdk_core.IResolvable No description.
attr_bandwidth ros_cdk_core.IResolvable No description.
attr_ip_address ros_cdk_core.IResolvable No description.
attr_load_balancer_id ros_cdk_core.IResolvable No description.
attr_load_balancer_name ros_cdk_core.IResolvable No description.
attr_load_balancer_spec ros_cdk_core.IResolvable No description.
attr_master_zone_id ros_cdk_core.IResolvable No description.
attr_network_type ros_cdk_core.IResolvable No description.
attr_order_id ros_cdk_core.IResolvable No description.
attr_pay_type ros_cdk_core.IResolvable No description.
attr_resource_group_id ros_cdk_core.IResolvable No description.
attr_slave_zone_id ros_cdk_core.IResolvable No description.
attr_vpc_id ros_cdk_core.IResolvable No description.
attr_v_switch_id ros_cdk_core.IResolvable No description.
enable_resource_property_constraint bool No description.
address_ip_version typing.Union[str, ros_cdk_core.IResolvable] No description.
address_type typing.Union[str, ros_cdk_core.IResolvable] No description.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] No description.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] No description.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] No description.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] No description.
load_balancer_name typing.Union[str, ros_cdk_core.IResolvable] No description.
load_balancer_spec typing.Union[str, ros_cdk_core.IResolvable] No description.
master_zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.
modification_protection_reason typing.Union[str, ros_cdk_core.IResolvable] No description.
modification_protection_status typing.Union[str, ros_cdk_core.IResolvable] No description.
pay_type typing.Union[str, ros_cdk_core.IResolvable] No description.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] No description.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] No description.
slave_zone_id typing.Union[str, ros_cdk_core.IResolvable] No description.
tags typing.List[TagsProperty] No description.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] No description.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


creation_stackRequired

creation_stack: typing.List[str]
  • Type: typing.List[str]

logical_idRequired

logical_id: str
  • Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


refRequired

ref: str
  • Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


ros_optionsRequired

ros_options: IRosResourceOptions
  • Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


ros_resource_typeRequired

ros_resource_type: str
  • Type: str

ROS resource type.


attr_address_ip_versionRequired

attr_address_ip_version: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_address_typeRequired

attr_address_type: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_bandwidthRequired

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_ip_addressRequired

attr_ip_address: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_load_balancer_idRequired

attr_load_balancer_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_load_balancer_nameRequired

attr_load_balancer_name: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_load_balancer_specRequired

attr_load_balancer_spec: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_master_zone_idRequired

attr_master_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_network_typeRequired

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_order_idRequired

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_pay_typeRequired

attr_pay_type: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_resource_group_idRequired

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_slave_zone_idRequired

attr_slave_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_vpc_idRequired

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

attr_v_switch_idRequired

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

enable_resource_property_constraintRequired

enable_resource_property_constraint: bool
  • Type: bool

address_ip_versionOptional

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

address_typeOptional

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

auto_payOptional

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

auto_renewOptional

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

auto_renew_periodOptional

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

bandwidthOptional

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

deletion_protectionOptional

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

durationOptional

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

instance_charge_typeOptional

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

internet_charge_typeOptional

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

load_balancer_nameOptional

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

load_balancer_specOptional

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

master_zone_idOptional

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

modification_protection_reasonOptional

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

modification_protection_statusOptional

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

pay_typeOptional

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

pricing_cycleOptional

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

resource_group_idOptional

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

slave_zone_idOptional

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

tagsOptional

tags: typing.List[TagsProperty]

vpc_idOptional

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

v_switch_idOptional

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

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME str The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

ROS_RESOURCE_TYPE_NAME: str
  • Type: str

The resource type name for this resource class.