Skip to content

ILoadBalancerTCPListener

  • Extends: com.aliyun.ros.cdk.core.IResource

  • Implemented By: com.aliyun.ros.cdk.slb.datasource.LoadBalancerTCPListener, com.aliyun.ros.cdk.slb.datasource.ILoadBalancerTCPListener

Represents a LoadBalancerTCPListener.

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node for this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
attrAclId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclId: The ID of the network ACL that is associated with the listener.
attrAclIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclIds: The ID list of the network ACL that is associated with the listener.
attrAclStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclStatus: Indicates whether access control is enabled.
attrAclType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclType: The type of the ACL.
attrBackendServerPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BackendServerPort: The backend port used by the CLB instance.
attrBandwidth java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Bandwidth: The maximum bandwidth of the listener.
attrConnectionDrain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionDrain: Indicates whether connection draining is enabled.
attrConnectionDrainTimeout java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionDrainTimeout: The timeout period of connection draining.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the listener.
attrEstablishedTimeout java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EstablishedTimeout: The timeout period of a connection.
attrHealthCheck java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheck: Indicates whether the health check feature is enabled.
attrHealthCheckConnectPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckConnectPort: The port that is used for health checks.
attrHealthCheckConnectTimeout java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckConnectTimeout: The timeout period.
attrHealthCheckDomain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckDomain: The domain name that is used for health checks.
attrHealthCheckHttpCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckHttpCode: The HTTP status code for a successful health check.
attrHealthCheckInterval java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckInterval: The interval between two consecutive health checks.
attrHealthCheckMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckMethod: The health check method.
attrHealthCheckType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckType: The health check method that is used by the TCP listener.
attrHealthCheckUri java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckUri: The URL that is used for health checks.
attrHealthyThreshold java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HealthyThreshold: The healthy threshold.
attrListenerPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ListenerPort: The frontend port used by the CLB instance.
attrLoadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancerId: The ID of the CLB instance.
attrMasterSlaveServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MasterSlaveServerGroupId: The ID of the primary/secondary server group that is associated with the listener.
attrPersistenceTimeout java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PersistenceTimeout: The timeout period of session persistence.
attrProxyProtocolV2Enabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ProxyProtocolV2Enabled: Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers.
attrScheduler java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Scheduler: The scheduling algorithm.
attrSynProxy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SynProxy: Indicates whether the SynProxy feature of CLB is enabled for protection.
attrUnhealthyThreshold java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UnhealthyThreshold: The unhealthy threshold.
attrVServerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VServerGroupId: The ID of the associated server group.
props LoadBalancerTCPListenerProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node for this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


attrAclIdRequired

public java.lang.Object getAttrAclId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrAclIdsRequired

public java.lang.Object getAttrAclIds();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrAclStatusRequired

public java.lang.Object getAttrAclStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AclStatus: Indicates whether access control is enabled.


attrAclTypeRequired

public java.lang.Object getAttrAclType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AclType: The type of the ACL.


attrBackendServerPortRequired

public java.lang.Object getAttrBackendServerPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrBandwidthRequired

public java.lang.Object getAttrBandwidth();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: The maximum bandwidth of the listener.

Unit: Mbit/s.


attrConnectionDrainRequired

public java.lang.Object getAttrConnectionDrain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionDrain: Indicates whether connection draining is enabled.

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


attrConnectionDrainTimeoutRequired

public java.lang.Object getAttrConnectionDrainTimeout();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionDrainTimeout: The timeout period of connection draining.

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


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the listener.


attrEstablishedTimeoutRequired

public java.lang.Object getAttrEstablishedTimeout();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EstablishedTimeout: The timeout period of a connection.


attrHealthCheckRequired

public java.lang.Object getAttrHealthCheck();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthCheckConnectPortRequired

public java.lang.Object getAttrHealthCheckConnectPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthCheckConnectTimeoutRequired

public java.lang.Object getAttrHealthCheckConnectTimeout();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.


attrHealthCheckDomainRequired

public java.lang.Object getAttrHealthCheckDomain();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthCheckHttpCodeRequired

public java.lang.Object getAttrHealthCheckHttpCode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthCheckIntervalRequired

public java.lang.Object getAttrHealthCheckInterval();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.


attrHealthCheckMethodRequired

public java.lang.Object getAttrHealthCheckMethod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckMethod: The health check method.


attrHealthCheckTypeRequired

public java.lang.Object getAttrHealthCheckType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthCheckUriRequired

public java.lang.Object getAttrHealthCheckUri();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHealthyThresholdRequired

public java.lang.Object getAttrHealthyThreshold();
  • Type: java.lang.String OR com.aliyun.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.


attrListenerPortRequired

public java.lang.Object getAttrListenerPort();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrLoadBalancerIdRequired

public java.lang.Object getAttrLoadBalancerId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancerId: The ID of the CLB instance.


attrMasterSlaveServerGroupIdRequired

public java.lang.Object getAttrMasterSlaveServerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrPersistenceTimeoutRequired

public java.lang.Object getAttrPersistenceTimeout();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PersistenceTimeout: The timeout period of session persistence.


attrProxyProtocolV2EnabledRequired

public java.lang.Object getAttrProxyProtocolV2Enabled();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrSchedulerRequired

public java.lang.Object getAttrScheduler();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Scheduler: The scheduling algorithm.


attrSynProxyRequired

public java.lang.Object getAttrSynProxy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrUnhealthyThresholdRequired

public java.lang.Object getAttrUnhealthyThreshold();
  • Type: java.lang.String OR com.aliyun.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.


attrVServerGroupIdRequired

public java.lang.Object getAttrVServerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VServerGroupId: The ID of the associated server group.


propsRequired

public LoadBalancerTCPListenerProps getProps();