Skip to content

LoadBalancerTCPListener

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

Initializers 

import com.aliyun.ros.cdk.slb.datasource.LoadBalancerTCPListener;
LoadBalancerTCPListener.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property listenerPort: The frontend port used by the CLB instance.Valid values: 1 to 65535.
loadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerId: The ID of the CLB instance.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

listenerPortRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

loadBalancerIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property loadBalancerId: The ID of the CLB instance.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.slb.datasource.LoadBalancerTCPListener;
LoadBalancerTCPListener.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

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

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

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

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAclIdRequired 

public IResolvable getAttrAclId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrAclIdsRequired 

public IResolvable getAttrAclIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrAclStatusRequired 

public IResolvable getAttrAclStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AclStatus: Indicates whether access control is enabled.

attrAclTypeRequired 

public IResolvable getAttrAclType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AclType: The type of the ACL.

attrBackendServerPortRequired 

public IResolvable getAttrBackendServerPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrBandwidthRequired 

public IResolvable getAttrBandwidth();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: The maximum bandwidth of the listener.

Unit: Mbit/s.

attrConnectionDrainRequired 

public IResolvable getAttrConnectionDrain();
  • Type: 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 IResolvable getAttrConnectionDrainTimeout();
  • Type: 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 IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the listener.

attrEstablishedTimeoutRequired 

public IResolvable getAttrEstablishedTimeout();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EstablishedTimeout: The timeout period of a connection.

attrHealthCheckRequired 

public IResolvable getAttrHealthCheck();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckConnectPortRequired 

public IResolvable getAttrHealthCheckConnectPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckConnectTimeoutRequired 

public IResolvable getAttrHealthCheckConnectTimeout();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.

attrHealthCheckDomainRequired 

public IResolvable getAttrHealthCheckDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckHttpCodeRequired 

public IResolvable getAttrHealthCheckHttpCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckIntervalRequired 

public IResolvable getAttrHealthCheckInterval();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

attrHealthCheckMethodRequired 

public IResolvable getAttrHealthCheckMethod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckMethod: The health check method.

attrHealthCheckTypeRequired 

public IResolvable getAttrHealthCheckType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckUriRequired 

public IResolvable getAttrHealthCheckUri();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHealthyThresholdRequired 

public IResolvable getAttrHealthyThreshold();
  • Type: 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 IResolvable getAttrListenerPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrLoadBalancerIdRequired 

public IResolvable getAttrLoadBalancerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancerId: The ID of the CLB instance.

attrMasterSlaveServerGroupIdRequired 

public IResolvable getAttrMasterSlaveServerGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrPersistenceTimeoutRequired 

public IResolvable getAttrPersistenceTimeout();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PersistenceTimeout: The timeout period of session persistence.

attrProxyProtocolV2EnabledRequired 

public IResolvable getAttrProxyProtocolV2Enabled();
  • Type: 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 IResolvable getAttrScheduler();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Scheduler: The scheduling algorithm.

attrSynProxyRequired 

public IResolvable getAttrSynProxy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrUnhealthyThresholdRequired 

public IResolvable getAttrUnhealthyThreshold();
  • Type: 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 IResolvable getAttrVServerGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VServerGroupId: The ID of the associated server group.