Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer 

import com.aliyun.ros.cdk.alb.ListenerProps;
ListenerProps.builder()
    .defaultActions(IResolvable)
    .defaultActions(java.util.List<IResolvable)
    .defaultActions(DefaultActionsProperty>)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .listenerProtocol(java.lang.String)
    .listenerProtocol(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
//  .caCertificates(IResolvable)
//  .caCertificates(java.util.List<IResolvable)
//  .caCertificates(CaCertificatesProperty>)
//  .caEnabled(java.lang.Boolean)
//  .caEnabled(IResolvable)
//  .certificates(IResolvable)
//  .certificates(java.util.List<IResolvable)
//  .certificates(CertificatesProperty>)
//  .gzipEnabled(java.lang.Boolean)
//  .gzipEnabled(IResolvable)
//  .http2Enabled(java.lang.Boolean)
//  .http2Enabled(IResolvable)
//  .idleTimeout(java.lang.Number)
//  .idleTimeout(IResolvable)
//  .listenerDescription(java.lang.String)
//  .listenerDescription(IResolvable)
//  .listenerStatus(java.lang.String)
//  .listenerStatus(IResolvable)
//  .quicConfig(IResolvable)
//  .quicConfig(QuicConfigProperty)
//  .requestTimeout(java.lang.Number)
//  .requestTimeout(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .xForwardedForConfig(IResolvable)
//  .xForwardedForConfig(XForwardedForConfigProperty)
    .build();

Properties

Name Type Description
defaultActions com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDefaultActionsProperty> Property defaultActions: The actions of the rule.
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property listenerPort: The frontend port that is used by the ALB instance.
listenerProtocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerProtocol: The listener protocol.
loadBalancerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerId: The ID of the ALB instance.
caCertificates com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCaCertificatesProperty> Property caCertificates: List of configured CA certificates for listener.
caEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property caEnabled: Specifies whether to enable mutual authentication.
certificates com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCertificatesProperty> Property certificates: The list of SSL certificates for listener.
gzipEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.
http2Enabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property http2Enabled: Specifies whether to enable HTTP\/2.
idleTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property idleTimeout: The timeout period of idle connections.
listenerDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerDescription: The description of the listener.
listenerStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerStatus: The status of the listener.
quicConfig com.aliyun.ros.cdk.core.IResolvable OR QuicConfigProperty Property quicConfig: Select a QUIC listener and associate it with the ALB instance.
requestTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property requestTimeout: The timeout period of the request.
securityPolicyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityPolicyId: The ID of the security policy.
xForwardedForConfig com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty Property xForwardedForConfig: The configuration of the XForward field.

defaultActionsRequired 

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

Property defaultActions: The actions of the rule.

listenerPortRequired 

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

Property listenerPort: The frontend port that is used by the ALB instance.

Valid values: 1 to 65535.

listenerProtocolRequired 

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

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.

loadBalancerIdRequired 

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

Property loadBalancerId: The ID of the ALB instance.

caCertificatesOptional 

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

Property caCertificates: List of configured CA certificates for listener.

caEnabledOptional 

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

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.

certificatesOptional 

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

Property certificates: The list of SSL certificates for listener.

gzipEnabledOptional 

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

Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.

Valid values: true and false. Default value: true.

http2EnabledOptional 

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

Property http2Enabled: Specifies whether to enable HTTP\/2.

Default value: on. Valid values: true and false. Default value: true. Note Only HTTPS listeners support this parameter.

idleTimeoutOptional 

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

Property idleTimeout: The timeout period of idle connections.

Valid values: 1 to 180. Unit: seconds. Default value: 15. If no request is received within the specified timeout period, ALB closes the connection. ALB recreates the connection when a new connection request is received.

listenerDescriptionOptional 

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

Property listenerDescription: The description of the listener.

The description must be 2 to 256 characters in length.

listenerStatusOptional 

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

Property listenerStatus: The status of the listener.

quicConfigOptional 

public java.lang.Object getQuicConfig();

Property quicConfig: Select a QUIC listener and associate it with the ALB instance.

requestTimeoutOptional 

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

Property requestTimeout: The timeout period of the request.

Valid values: 1 to 180. Unit: seconds. Default value: 60. If no response is received from the backend server during the request timeout period, ALB sends an HTTP 504 error code to the client.

securityPolicyIdOptional 

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

Property securityPolicyId: The ID of the security policy.

System security policies and custom security policies are supported. Default value: tls_cipher_policy_1_0. This value indicates a system security policy. Note Only HTTPS listeners support this parameter.

xForwardedForConfigOptional 

public java.lang.Object getXForwardedForConfig();

Property xForwardedForConfig: The configuration of the XForward field.