Skip to content

LoadBalancerTCPListener

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

Initializers 

from ros_cdk_slb import datasource
datasource.LoadBalancerTCPListener(
  scope: Construct,
  id: str,
  listener_port: typing.Union[typing.Union[int, float], IResolvable],
  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.
listener_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property listenerPort: The frontend port used by the CLB instance.Valid values: 1 to 65535.
load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerId: The ID of the CLB instance.
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

listener_portRequired

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

Property listenerPort: The frontend port used by the CLB instance.Valid values: 1 to 65535.

load_balancer_idRequired

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

Property loadBalancerId: The ID of the CLB instance.

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.LoadBalancerTCPListener.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_acl_id ros_cdk_core.IResolvable Attribute AclId: The ID of the network ACL that is associated with the listener.
attr_acl_ids ros_cdk_core.IResolvable Attribute AclIds: The ID list of the network ACL that is associated with the listener.
attr_acl_status ros_cdk_core.IResolvable Attribute AclStatus: Indicates whether access control is enabled.
attr_acl_type ros_cdk_core.IResolvable Attribute AclType: The type of the ACL.
attr_backend_server_port ros_cdk_core.IResolvable Attribute BackendServerPort: The backend port used by the CLB instance.
attr_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: The maximum bandwidth of the listener.
attr_connection_drain ros_cdk_core.IResolvable Attribute ConnectionDrain: Indicates whether connection draining is enabled.
attr_connection_drain_timeout ros_cdk_core.IResolvable Attribute ConnectionDrainTimeout: The timeout period of connection draining.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the listener.
attr_established_timeout ros_cdk_core.IResolvable Attribute EstablishedTimeout: The timeout period of a connection.
attr_health_check ros_cdk_core.IResolvable Attribute HealthCheck: Indicates whether the health check feature is enabled.
attr_health_check_connect_port ros_cdk_core.IResolvable Attribute HealthCheckConnectPort: The port that is used for health checks.
attr_health_check_connect_timeout ros_cdk_core.IResolvable Attribute HealthCheckConnectTimeout: The timeout period.
attr_health_check_domain ros_cdk_core.IResolvable Attribute HealthCheckDomain: The domain name that is used for health checks.
attr_health_check_http_code ros_cdk_core.IResolvable Attribute HealthCheckHttpCode: The HTTP status code for a successful health check.
attr_health_check_interval ros_cdk_core.IResolvable Attribute HealthCheckInterval: The interval between two consecutive health checks.
attr_health_check_method ros_cdk_core.IResolvable Attribute HealthCheckMethod: The health check method.
attr_health_check_type ros_cdk_core.IResolvable Attribute HealthCheckType: The health check method that is used by the TCP listener.
attr_health_check_uri ros_cdk_core.IResolvable Attribute HealthCheckUri: The URL that is used for health checks.
attr_healthy_threshold ros_cdk_core.IResolvable Attribute HealthyThreshold: The healthy threshold.
attr_listener_port ros_cdk_core.IResolvable Attribute ListenerPort: The frontend port used by the CLB instance.
attr_load_balancer_id ros_cdk_core.IResolvable Attribute LoadBalancerId: The ID of the CLB instance.
attr_master_slave_server_group_id ros_cdk_core.IResolvable Attribute MasterSlaveServerGroupId: The ID of the primary/secondary server group that is associated with the listener.
attr_persistence_timeout ros_cdk_core.IResolvable Attribute PersistenceTimeout: The timeout period of session persistence.
attr_proxy_protocol_v2_enabled ros_cdk_core.IResolvable Attribute ProxyProtocolV2Enabled: Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers.
attr_scheduler ros_cdk_core.IResolvable Attribute Scheduler: The scheduling algorithm.
attr_syn_proxy ros_cdk_core.IResolvable Attribute SynProxy: Indicates whether the SynProxy feature of CLB is enabled for protection.
attr_unhealthy_threshold ros_cdk_core.IResolvable Attribute UnhealthyThreshold: The unhealthy threshold.
attr_v_server_group_id ros_cdk_core.IResolvable Attribute VServerGroupId: The ID of the associated server group.

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_acl_idRequired 

attr_acl_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclId: The ID of the network ACL that is associated with the listener.

attr_acl_idsRequired 

attr_acl_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclIds: The ID list of the network ACL that is associated with the listener.

attr_acl_statusRequired 

attr_acl_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclStatus: Indicates whether access control is enabled.

attr_acl_typeRequired 

attr_acl_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclType: The type of the ACL.

attr_backend_server_portRequired 

attr_backend_server_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackendServerPort: The backend port used by the CLB instance.

attr_bandwidthRequired 

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The maximum bandwidth of the listener.

Unit: Mbit/s.

attr_connection_drainRequired 

attr_connection_drain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionDrain: Indicates whether connection draining is enabled.

If ConnectionDrain is set to on, the parameter is returned.

attr_connection_drain_timeoutRequired 

attr_connection_drain_timeout: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionDrainTimeout: The timeout period of connection draining.

If ConnectionDrain is set to on, the parameter is returned.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the listener.

attr_established_timeoutRequired 

attr_established_timeout: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EstablishedTimeout: The timeout period of a connection.

attr_health_checkRequired 

attr_health_check: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheck: Indicates whether the health check feature is enabled.

attr_health_check_connect_portRequired 

attr_health_check_connect_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckConnectPort: The port that is used for health checks.

attr_health_check_connect_timeoutRequired 

attr_health_check_connect_timeout: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.

attr_health_check_domainRequired 

attr_health_check_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckDomain: The domain name that is used for health checks.

attr_health_check_http_codeRequired 

attr_health_check_http_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckHttpCode: The HTTP status code for a successful health check.

attr_health_check_intervalRequired 

attr_health_check_interval: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

attr_health_check_methodRequired 

attr_health_check_method: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckMethod: The health check method.

attr_health_check_typeRequired 

attr_health_check_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckType: The health check method that is used by the TCP listener.

attr_health_check_uriRequired 

attr_health_check_uri: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthCheckUri: The URL that is used for health checks.

attr_healthy_thresholdRequired 

attr_healthy_threshold: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HealthyThreshold: The healthy threshold.

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success. Valid values: 2 to 10.

attr_listener_portRequired 

attr_listener_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ListenerPort: The frontend port used by the CLB instance.

attr_load_balancer_idRequired 

attr_load_balancer_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LoadBalancerId: The ID of the CLB instance.

attr_master_slave_server_group_idRequired 

attr_master_slave_server_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterSlaveServerGroupId: The ID of the primary/secondary server group that is associated with the listener.

attr_persistence_timeoutRequired 

attr_persistence_timeout: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PersistenceTimeout: The timeout period of session persistence.

attr_proxy_protocol_v2_enabledRequired 

attr_proxy_protocol_v2_enabled: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProxyProtocolV2Enabled: Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers.

attr_schedulerRequired 

attr_scheduler: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Scheduler: The scheduling algorithm.

attr_syn_proxyRequired 

attr_syn_proxy: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SynProxy: Indicates whether the SynProxy feature of CLB is enabled for protection.

attr_unhealthy_thresholdRequired 

attr_unhealthy_threshold: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UnhealthyThreshold: The unhealthy threshold.

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail. Valid values: 2 to 10.

attr_v_server_group_idRequired 

attr_v_server_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VServerGroupId: The ID of the associated server group.