LoadBalancerTCPListener

• Implements: com.aliyun.ros.cdk.slb.datasource.ILoadBalancerTCPListener

This class encapsulates and extends the ROS resource type DATASOURCE::SLB::LoadBalancerTCPListener, which is used to query the configurations of a TCP listener.

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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

listenerPort^Required

• 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.

loadBalancerId^Required

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

Property loadBalancerId: The ID of the CLB instance.

refreshOptions^Optional

• 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

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrAclId^Required

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.

attrAclIds^Required

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.

attrAclStatus^Required

public java.lang.Object getAttrAclStatus();

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

Attribute AclStatus: Indicates whether access control is enabled.

attrAclType^Required

public java.lang.Object getAttrAclType();

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

Attribute AclType: The type of the ACL.

attrBackendServerPort^Required

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.

attrBandwidth^Required

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.

attrConnectionDrain^Required

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.

attrConnectionDrainTimeout^Required

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.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The description of the listener.

attrEstablishedTimeout^Required

public java.lang.Object getAttrEstablishedTimeout();

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

Attribute EstablishedTimeout: The timeout period of a connection.

attrHealthCheck^Required

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.

attrHealthCheckConnectPort^Required

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.

attrHealthCheckConnectTimeout^Required

public java.lang.Object getAttrHealthCheckConnectTimeout();

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

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.

attrHealthCheckDomain^Required

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.

attrHealthCheckHttpCode^Required

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.

attrHealthCheckInterval^Required

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.

attrHealthCheckMethod^Required

public java.lang.Object getAttrHealthCheckMethod();

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

Attribute HealthCheckMethod: The health check method.

attrHealthCheckType^Required

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.

attrHealthCheckUri^Required

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.

attrHealthyThreshold^Required

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.

attrListenerPort^Required

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.

attrLoadBalancerId^Required

public java.lang.Object getAttrLoadBalancerId();

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

Attribute LoadBalancerId: The ID of the CLB instance.

attrMasterSlaveServerGroupId^Required

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.

attrPersistenceTimeout^Required

public java.lang.Object getAttrPersistenceTimeout();

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

Attribute PersistenceTimeout: The timeout period of session persistence.

attrProxyProtocolV2Enabled^Required

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.

attrScheduler^Required

public java.lang.Object getAttrScheduler();

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

Attribute Scheduler: The scheduling algorithm.

attrSynProxy^Required

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.

attrUnhealthyThreshold^Required

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.

attrVServerGroupId^Required

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.

props^Required

public LoadBalancerTCPListenerProps getProps();

• Type: LoadBalancerTCPListenerProps