LoadBalancers
This class encapsulates and extends the ROS resource type DATASOURCE::NLB::LoadBalancers
, which is used to query the basic information about created Network Load Balancer (NLB) instances.
Initializers
from ros_cdk_nlb import datasource
datasource.LoadBalancers(
scope: Construct,
id: str,
address_ip_version: typing.Union[str, IResolvable] = None,
address_type: typing.Union[str, IResolvable] = None,
ipv6_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,
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_ip_version |
typing.Union[str, ros_cdk_core.IResolvable] |
Property addressIpVersion: IP version. |
address_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property addressType: The address type of the load balancing instance. |
ipv6_address_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property ipv6AddressType: IPv6 address type of network load balancing. |
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. |
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_nlb.datasource.RosLoadBalancers.TagsProperty] |
Property tags: Tags of Nlb. |
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. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
address_ip_version
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property addressIpVersion: IP version.
address_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property addressType: The address type of the load balancing instance.
ipv6_address_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipv6AddressType: IPv6 address type of network load balancing.
load_balancer_bussiness_status
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loadBalancerBussinessStatus: Service status of application load balancing.
load_balancer_ids
Optional
- 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_names
Optional
- 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_status
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property loadBalancerStatus: The status of SLB.
refresh_options
Optional
- 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_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Resource group id.
tags
Optional
- Type: typing.List[ros_cdk_nlb.datasource.RosLoadBalancers.TagsProperty]
Property tags: Tags of Nlb.
vpc_ids
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property vpcIds: VPC IDs.
zone_id
Optional
- 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_constraint
Optional
- 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
from ros_cdk_nlb import datasource
datasource.LoadBalancers.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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_load_balancer_ids
Required
attr_load_balancer_ids: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LoadBalancerIds: The list of load balancer IDs.
attr_load_balancers
Required
attr_load_balancers: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LoadBalancers: The list of load balancers.