Skip to content

LoadBalancerTCPListener

  • Implements: AlibabaCloud.SDK.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

using AlibabaCloud.SDK.ROS.CDK.Slb;
new LoadBalancerTCPListener(Construct Scope, string Id, LoadBalancerTCPListenerProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props LoadBalancerTCPListenerProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • Type: bool

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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc No description.
GetAtt No description.
SetMetadata No description.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Slb;
LoadBalancerTCPListener.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrAclId object Attribute AclId: The ID of the network ACL that is associated with the listener.
AttrAclIds object Attribute AclIds: The ID list of the network ACL that is associated with the listener.
AttrAclStatus object Attribute AclStatus: Indicates whether access control is enabled.
AttrAclType object Attribute AclType: The type of the ACL.
AttrBackendServerPort object Attribute BackendServerPort: The backend port used by the CLB instance.
AttrBandwidth object Attribute Bandwidth: The maximum bandwidth of the listener.
AttrConnectionDrain object Attribute ConnectionDrain: Indicates whether connection draining is enabled.
AttrConnectionDrainTimeout object Attribute ConnectionDrainTimeout: The timeout period of connection draining.
AttrDescription object Attribute Description: The description of the listener.
AttrEstablishedTimeout object Attribute EstablishedTimeout: The timeout period of a connection.
AttrHealthCheck object Attribute HealthCheck: Indicates whether the health check feature is enabled.
AttrHealthCheckConnectPort object Attribute HealthCheckConnectPort: The port that is used for health checks.
AttrHealthCheckConnectTimeout object Attribute HealthCheckConnectTimeout: The timeout period.
AttrHealthCheckDomain object Attribute HealthCheckDomain: The domain name that is used for health checks.
AttrHealthCheckHttpCode object Attribute HealthCheckHttpCode: The HTTP status code for a successful health check.
AttrHealthCheckInterval object Attribute HealthCheckInterval: The interval between two consecutive health checks.
AttrHealthCheckMethod object Attribute HealthCheckMethod: The health check method.
AttrHealthCheckType object Attribute HealthCheckType: The health check method that is used by the TCP listener.
AttrHealthCheckUri object Attribute HealthCheckUri: The URL that is used for health checks.
AttrHealthyThreshold object Attribute HealthyThreshold: The healthy threshold.
AttrListenerPort object Attribute ListenerPort: The frontend port used by the CLB instance.
AttrLoadBalancerId object Attribute LoadBalancerId: The ID of the CLB instance.
AttrMasterSlaveServerGroupId object Attribute MasterSlaveServerGroupId: The ID of the primary/secondary server group that is associated with the listener.
AttrPersistenceTimeout object Attribute PersistenceTimeout: The timeout period of session persistence.
AttrProxyProtocolV2Enabled object Attribute ProxyProtocolV2Enabled: Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers.
AttrScheduler object Attribute Scheduler: The scheduling algorithm.
AttrSynProxy object Attribute SynProxy: Indicates whether the SynProxy feature of CLB is enabled for protection.
AttrUnhealthyThreshold object Attribute UnhealthyThreshold: The unhealthy threshold.
AttrVServerGroupId object Attribute VServerGroupId: The ID of the associated server group.
Props LoadBalancerTCPListenerProps No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.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.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAclIdRequired

public object AttrAclId { get; }
  • Type: object

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


AttrAclIdsRequired

public object AttrAclIds { get; }
  • Type: object

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


AttrAclStatusRequired

public object AttrAclStatus { get; }
  • Type: object

Attribute AclStatus: Indicates whether access control is enabled.


AttrAclTypeRequired

public object AttrAclType { get; }
  • Type: object

Attribute AclType: The type of the ACL.


AttrBackendServerPortRequired

public object AttrBackendServerPort { get; }
  • Type: object

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


AttrBandwidthRequired

public object AttrBandwidth { get; }
  • Type: object

Attribute Bandwidth: The maximum bandwidth of the listener.

Unit: Mbit/s.


AttrConnectionDrainRequired

public object AttrConnectionDrain { get; }
  • Type: object

Attribute ConnectionDrain: Indicates whether connection draining is enabled.

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


AttrConnectionDrainTimeoutRequired

public object AttrConnectionDrainTimeout { get; }
  • Type: object

Attribute ConnectionDrainTimeout: The timeout period of connection draining.

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


AttrDescriptionRequired

public object AttrDescription { get; }
  • Type: object

Attribute Description: The description of the listener.


AttrEstablishedTimeoutRequired

public object AttrEstablishedTimeout { get; }
  • Type: object

Attribute EstablishedTimeout: The timeout period of a connection.


AttrHealthCheckRequired

public object AttrHealthCheck { get; }
  • Type: object

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


AttrHealthCheckConnectPortRequired

public object AttrHealthCheckConnectPort { get; }
  • Type: object

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


AttrHealthCheckConnectTimeoutRequired

public object AttrHealthCheckConnectTimeout { get; }
  • Type: object

Attribute HealthCheckConnectTimeout: The timeout period.

Unit: seconds.


AttrHealthCheckDomainRequired

public object AttrHealthCheckDomain { get; }
  • Type: object

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


AttrHealthCheckHttpCodeRequired

public object AttrHealthCheckHttpCode { get; }
  • Type: object

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


AttrHealthCheckIntervalRequired

public object AttrHealthCheckInterval { get; }
  • Type: object

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.


AttrHealthCheckMethodRequired

public object AttrHealthCheckMethod { get; }
  • Type: object

Attribute HealthCheckMethod: The health check method.


AttrHealthCheckTypeRequired

public object AttrHealthCheckType { get; }
  • Type: object

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


AttrHealthCheckUriRequired

public object AttrHealthCheckUri { get; }
  • Type: object

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


AttrHealthyThresholdRequired

public object AttrHealthyThreshold { get; }
  • Type: object

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 object AttrListenerPort { get; }
  • Type: object

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


AttrLoadBalancerIdRequired

public object AttrLoadBalancerId { get; }
  • Type: object

Attribute LoadBalancerId: The ID of the CLB instance.


AttrMasterSlaveServerGroupIdRequired

public object AttrMasterSlaveServerGroupId { get; }
  • Type: object

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


AttrPersistenceTimeoutRequired

public object AttrPersistenceTimeout { get; }
  • Type: object

Attribute PersistenceTimeout: The timeout period of session persistence.


AttrProxyProtocolV2EnabledRequired

public object AttrProxyProtocolV2Enabled { get; }
  • Type: object

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


AttrSchedulerRequired

public object AttrScheduler { get; }
  • Type: object

Attribute Scheduler: The scheduling algorithm.


AttrSynProxyRequired

public object AttrSynProxy { get; }
  • Type: object

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


AttrUnhealthyThresholdRequired

public object AttrUnhealthyThreshold { get; }
  • Type: object

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 object AttrVServerGroupId { get; }
  • Type: object

Attribute VServerGroupId: The ID of the associated server group.


PropsRequired

public LoadBalancerTCPListenerProps Props { get; }