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)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .quicConfig(IResolvable)
//  .quicConfig(QuicConfigProperty)
//  .requestTimeout(java.lang.Number)
//  .requestTimeout(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .xForwardedForConfig(IResolvable)
//  .xForwardedForConfig(XForwardedForConfigProperty)
    .build();

Properties

defaultActions^Required

public java.lang.Object getDefaultActions();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDefaultActionsProperty>

Property defaultActions: The default actions for the listener.

listenerPort^Required

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.

listenerProtocol^Required

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.

loadBalancerId^Required

public java.lang.Object getLoadBalancerId();

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

Property loadBalancerId: The ID of the ALB instance.

caCertificates^Optional

public java.lang.Object getCaCertificates();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCaCertificatesProperty>

Property caCertificates: A list of CA certificates for the listener.

Only one CA certificate is supported.

caEnabled^Optional

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.

certificates^Optional

public java.lang.Object getCertificates();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCertificatesProperty>

Property certificates: A list of server certificates.

gzipEnabled^Optional

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.

http2Enabled^Optional

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.

idleTimeout^Optional

public java.lang.Object getIdleTimeout();

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

Property idleTimeout: The idle timeout in seconds.

Valid values: 1 to 600. Default value: 15. If no requests are received on a connection within the idle timeout, the load balancer closes the connection. A new connection is established for the next request.

You can request a quota increase to a maximum of 3,600 seconds.

listenerDescription^Optional

public java.lang.Object getListenerDescription();

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

Property listenerDescription: A custom name for the listener.

The name must be 2 to 256 characters long and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), underscores (_), and Chinese characters.

listenerStatus^Optional

public java.lang.Object getListenerStatus();

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

Property listenerStatus: The status of the listener.

logConfig^Optional

public java.lang.Object getLogConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR LogConfigProperty

Property logConfig: The configuration information about the access log.

quicConfig^Optional

public java.lang.Object getQuicConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR QuicConfigProperty

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

requestTimeout^Optional

public java.lang.Object getRequestTimeout();

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

Property requestTimeout: The request timeout in seconds.

Valid values: 1 to 600. Default value: 60. If a backend server does not respond within the timeout period, the load balancer returns an HTTP 504 error to the client.

You can request a quota increase to a maximum of 3,600 seconds.

securityPolicyId^Optional

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.

xForwardedForConfig^Optional

public java.lang.Object getXForwardedForConfig();

• Type: com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty

Property xForwardedForConfig: The configuration of X-Forwarded-* headers.