Skip to content

ILoadBalancerTCPListener

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_slb.datasource.LoadBalancerTCPListener, ros_cdk_slb.datasource.ILoadBalancerTCPListener

Represents a LoadBalancerTCPListener.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_acl_id typing.Union[str, ros_cdk_core.IResolvable] Attribute AclId: The ID of the network ACL that is associated with the listener.
attr_acl_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute AclIds: The ID list of the network ACL that is associated with the listener.
attr_acl_status typing.Union[str, ros_cdk_core.IResolvable] Attribute AclStatus: Indicates whether access control is enabled.
attr_acl_type typing.Union[str, ros_cdk_core.IResolvable] Attribute AclType: The type of the ACL.
attr_backend_server_port typing.Union[str, ros_cdk_core.IResolvable] Attribute BackendServerPort: The backend port used by the CLB instance.
attr_bandwidth typing.Union[str, ros_cdk_core.IResolvable] Attribute Bandwidth: The maximum bandwidth of the listener.
attr_connection_drain typing.Union[str, ros_cdk_core.IResolvable] Attribute ConnectionDrain: Indicates whether connection draining is enabled.
attr_connection_drain_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute ConnectionDrainTimeout: The timeout period of connection draining.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The description of the listener.
attr_established_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute EstablishedTimeout: The timeout period of a connection.
attr_health_check typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheck: Indicates whether the health check feature is enabled.
attr_health_check_connect_port typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckConnectPort: The port that is used for health checks.
attr_health_check_connect_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckConnectTimeout: The timeout period.
attr_health_check_domain typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckDomain: The domain name that is used for health checks.
attr_health_check_http_code typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckHttpCode: The HTTP status code for a successful health check.
attr_health_check_interval typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckInterval: The interval between two consecutive health checks.
attr_health_check_method typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckMethod: The health check method.
attr_health_check_type typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckType: The health check method that is used by the TCP listener.
attr_health_check_uri typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckUri: The URL that is used for health checks.
attr_healthy_threshold typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthyThreshold: The healthy threshold.
attr_listener_port typing.Union[str, ros_cdk_core.IResolvable] Attribute ListenerPort: The frontend port used by the CLB instance.
attr_load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Attribute LoadBalancerId: The ID of the CLB instance.
attr_master_slave_server_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute MasterSlaveServerGroupId: The ID of the primary/secondary server group that is associated with the listener.
attr_persistence_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute PersistenceTimeout: The timeout period of session persistence.
attr_proxy_protocol_v2_enabled typing.Union[str, ros_cdk_core.IResolvable] Attribute ProxyProtocolV2Enabled: Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers.
attr_scheduler typing.Union[str, ros_cdk_core.IResolvable] Attribute Scheduler: The scheduling algorithm.
attr_syn_proxy typing.Union[str, ros_cdk_core.IResolvable] Attribute SynProxy: Indicates whether the SynProxy feature of CLB is enabled for protection.
attr_unhealthy_threshold typing.Union[str, ros_cdk_core.IResolvable] Attribute UnhealthyThreshold: The unhealthy threshold.
attr_v_server_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VServerGroupId: The ID of the associated server group.
props LoadBalancerTCPListenerProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_acl_idRequired

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

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


attr_acl_idsRequired

attr_acl_ids: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute AclStatus: Indicates whether access control is enabled.


attr_acl_typeRequired

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

Attribute AclType: The type of the ACL.


attr_backend_server_portRequired

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

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


attr_bandwidthRequired

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

Attribute Bandwidth: The maximum bandwidth of the listener.

Unit: Mbit/s.


attr_connection_drainRequired

attr_connection_drain: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Description: The description of the listener.


attr_established_timeoutRequired

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

Attribute EstablishedTimeout: The timeout period of a connection.


attr_health_checkRequired

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

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


attr_health_check_connect_portRequired

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

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


attr_health_check_connect_timeoutRequired

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

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.


attr_health_check_domainRequired

attr_health_check_domain: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_health_check_intervalRequired

attr_health_check_interval: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckMethod: The health check method.


attr_health_check_typeRequired

attr_health_check_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_healthy_thresholdRequired

attr_healthy_threshold: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_load_balancer_idRequired

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

Attribute LoadBalancerId: The ID of the CLB instance.


attr_master_slave_server_group_idRequired

attr_master_slave_server_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PersistenceTimeout: The timeout period of session persistence.


attr_proxy_protocol_v2_enabledRequired

attr_proxy_protocol_v2_enabled: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Scheduler: The scheduling algorithm.


attr_syn_proxyRequired

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

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


attr_unhealthy_thresholdRequired

attr_unhealthy_threshold: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VServerGroupId: The ID of the associated server group.


propsRequired

props: LoadBalancerTCPListenerProps