Skip to content

ListenerProps

Properties for defining a Listener.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-nlb-listener

Initializer

import com.aliyun.ros.cdk.nlb.ListenerProps;
ListenerProps.builder()
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .listenerProtocol(java.lang.String)
    .listenerProtocol(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
//  .alpnEnabled(java.lang.Boolean)
//  .alpnEnabled(IResolvable)
//  .alpnPolicy(java.lang.String)
//  .alpnPolicy(IResolvable)
//  .caCertificateIds(IResolvable)
//  .caCertificateIds(java.util.List<java.lang.String)
//  .caCertificateIds(IResolvable>)
//  .caEnabled(java.lang.Boolean)
//  .caEnabled(IResolvable)
//  .certificateIds(IResolvable)
//  .certificateIds(java.util.List<java.lang.String)
//  .certificateIds(IResolvable>)
//  .cps(java.lang.Number)
//  .cps(IResolvable)
//  .enable(java.lang.Boolean)
//  .enable(IResolvable)
//  .endPort(java.lang.Number)
//  .endPort(IResolvable)
//  .idleTimeout(java.lang.Number)
//  .idleTimeout(IResolvable)
//  .listenerDescription(java.lang.String)
//  .listenerDescription(IResolvable)
//  .mss(java.lang.Number)
//  .mss(IResolvable)
//  .proxyProtocolEnabled(java.lang.Boolean)
//  .proxyProtocolEnabled(IResolvable)
//  .proxyProtocolV2Config(IResolvable)
//  .proxyProtocolV2Config(ProxyProtocolV2ConfigProperty)
//  .secSensorEnabled(java.lang.Boolean)
//  .secSensorEnabled(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .serverGroupId(java.lang.String)
//  .serverGroupId(IResolvable)
//  .serverGroupTuples(IResolvable)
//  .serverGroupTuples(java.util.List<IResolvable)
//  .serverGroupTuples(ServerGroupTuplesProperty>)
//  .startPort(java.lang.Number)
//  .startPort(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property listenerPort: Port of the listener,[0, 65535] the portRange setting need 0.
listenerProtocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerProtocol: Listening protocol.
loadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerId: ID of the LoadBalancer.
alpnEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property alpnEnabled: undefined.
alpnPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property alpnPolicy: Proxy of alpn.
caCertificateIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property caCertificateIds: List of the ca certificate ids.
caEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property caEnabled: Whether to open CA.
certificateIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property certificateIds: List of the certificate ids.
cps java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cps: New connection rate limit of Instance.
enable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enable: Whether to start listener or not.
endPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property endPort: EndPort of the portRange.
idleTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property idleTimeout: Specifies the connection idle timeout.
listenerDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerDescription: Description of the listener, [2, 256] characters.
mss java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property mss: Max length of the TCP packet.
proxyProtocolEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property proxyProtocolEnabled: Whether to enable ppv2 function.
proxyProtocolV2Config com.aliyun.ros.cdk.core.IResolvable OR ProxyProtocolV2ConfigProperty Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.
secSensorEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property secSensorEnabled: Whether to enable the second-level monitoring function.
securityPolicyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityPolicyId: Only valid for TcpSSL protocol monitoring.
serverGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serverGroupId: ID of the ServerGroup.
serverGroupTuples com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServerGroupTuplesProperty> Property serverGroupTuples: Multi-server group list.
startPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property startPort: StartPort of the portRange.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.

listenerPortRequired

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

Property listenerPort: Port of the listener,[0, 65535] the portRange setting need 0.


listenerProtocolRequired

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

Property listenerProtocol: Listening protocol.

Values: TCP, UDP, or TCPSSL.


loadBalancerIdRequired

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

Property loadBalancerId: ID of the LoadBalancer.


alpnEnabledOptional

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

Property alpnEnabled: undefined.


alpnPolicyOptional

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

Property alpnPolicy: Proxy of alpn.


caCertificateIdsOptional

public java.lang.Object getCaCertificateIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property caCertificateIds: List of the ca certificate ids.


caEnabledOptional

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

Property caEnabled: Whether to open CA.


certificateIdsOptional

public java.lang.Object getCertificateIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property certificateIds: List of the certificate ids.


cpsOptional

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

Property cps: New connection rate limit of Instance.


enableOptional

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

Property enable: Whether to start listener or not.

Default True.


endPortOptional

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

Property endPort: EndPort of the portRange.


idleTimeoutOptional

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

Property idleTimeout: Specifies the connection idle timeout.


listenerDescriptionOptional

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

Property listenerDescription: Description of the listener, [2, 256] characters.


mssOptional

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

Property mss: Max length of the TCP packet.


proxyProtocolEnabledOptional

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

Property proxyProtocolEnabled: Whether to enable ppv2 function.


proxyProtocolV2ConfigOptional

public java.lang.Object getProxyProtocolV2Config();

Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.


secSensorEnabledOptional

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

Property secSensorEnabled: Whether to enable the second-level monitoring function.


securityPolicyIdOptional

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

Property securityPolicyId: Only valid for TcpSSL protocol monitoring.


serverGroupIdOptional

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

Property serverGroupId: ID of the ServerGroup.


serverGroupTuplesOptional

public java.lang.Object getServerGroupTuples();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServerGroupTuplesProperty>

Property serverGroupTuples: Multi-server group list.

When the number of destination server groups is 1, the default value is 100 if no weight is specified. When the number of destination server groups is greater than 1, the user needs to specify the weight value.


startPortOptional

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

Property startPort: StartPort of the portRange.


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.