Skip to content

LoadBalancers

This class encapsulates and extends the ROS resource type DATASOURCE::ALB::LoadBalancers, which is used to query the basic information about created Application Load Balancer (ALB) instances.

Initializers 

from ros_cdk_alb import datasource
datasource.LoadBalancers(
  scope: Construct,
  id: str,
  address_type: typing.Union[str, IResolvable] = None,
  load_balancer_bussiness_status: typing.Union[str, IResolvable] = None,
  load_balancer_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  load_balancer_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  load_balancer_status: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  zone_id: 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.
address_type typing.Union[str, ros_cdk_core.IResolvable] Property addressType: The address type of the load balancing instance.
load_balancer_bussiness_status typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerBussinessStatus: Service status of application load balancing.
load_balancer_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property loadBalancerIds: IDs of the load balancer instance.
load_balancer_names typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property loadBalancerNames: Names of the load balancing instance.
load_balancer_status typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerStatus: The status of SLB.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: Load balancing instance payment type.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
tags typing.List[ros_cdk_alb.datasource.RosLoadBalancers.TagsProperty] Property tags: Tags of Alb.
vpc_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property vpcIds: VPC IDs.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: ID of the ready-to-use zone of the load balancing instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

address_typeOptional

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

Property addressType: The address type of the load balancing instance.

load_balancer_bussiness_statusOptional

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

Property loadBalancerBussinessStatus: Service status of application load balancing.

load_balancer_idsOptional

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

Property loadBalancerIds: IDs of the load balancer instance.

load_balancer_namesOptional

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

Property loadBalancerNames: Names of the load balancing instance.

load_balancer_statusOptional

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

Property loadBalancerStatus: The status of SLB.

pay_typeOptional

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

Property payType: Load balancing instance payment type.

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.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

tagsOptional

  • Type: typing.List[ros_cdk_alb.datasource.RosLoadBalancers.TagsProperty]

Property tags: Tags of Alb.

vpc_idsOptional

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

Property vpcIds: VPC IDs.

zone_idOptional

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

Property zoneId: ID of the ready-to-use zone of the load balancing instance.

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_alb import datasource
datasource.LoadBalancers.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_load_balancer_ids ros_cdk_core.IResolvable Attribute LoadBalancerIds: The list of load balancer IDs.
attr_load_balancers ros_cdk_core.IResolvable Attribute LoadBalancers: The list of load balancers.

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_load_balancer_idsRequired 

attr_load_balancer_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerIds: The list of load balancer IDs.

attr_load_balancersRequired 

attr_load_balancers: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancers: The list of load balancers.