Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Alb;
new ListenerProps {
    object DefaultActions,
    object ListenerPort,
    object ListenerProtocol,
    object LoadBalancerId,
    object CaCertificates = null,
    object CaEnabled = null,
    object Certificates = null,
    object GzipEnabled = null,
    object Http2Enabled = null,
    object IdleTimeout = null,
    object ListenerDescription = null,
    object ListenerStatus = null,
    object QuicConfig = null,
    object RequestTimeout = null,
    object SecurityPolicyId = null,
    object XForwardedForConfig = null
};

Properties

Name Type Description
DefaultActions object Property defaultActions: The actions of the rule.
ListenerPort object Property listenerPort: The frontend port that is used by the ALB instance.
ListenerProtocol object Property listenerProtocol: The listener protocol.
LoadBalancerId object Property loadBalancerId: The ID of the ALB instance.
CaCertificates object Property caCertificates: List of configured CA certificates for listener.
CaEnabled object Property caEnabled: Specifies whether to enable mutual authentication.
Certificates object Property certificates: The list of SSL certificates for listener.
GzipEnabled object Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.
Http2Enabled object Property http2Enabled: Specifies whether to enable HTTP\/2.
IdleTimeout object Property idleTimeout: The timeout period of idle connections.
ListenerDescription object Property listenerDescription: The description of the listener.
ListenerStatus object Property listenerStatus: The status of the listener.
QuicConfig object Property quicConfig: Select a QUIC listener and associate it with the ALB instance.
RequestTimeout object Property requestTimeout: The timeout period of the request.
SecurityPolicyId object Property securityPolicyId: The ID of the security policy.
XForwardedForConfig object Property xForwardedForConfig: The configuration of the XForward field.

DefaultActionsRequired

public object DefaultActions { get; set; }
  • Type: object

Property defaultActions: The actions of the rule.


ListenerPortRequired

public object ListenerPort { get; set; }
  • Type: object

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

Valid values: 1 to 65535.


ListenerProtocolRequired

public object ListenerProtocol { get; set; }
  • Type: object

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.


LoadBalancerIdRequired

public object LoadBalancerId { get; set; }
  • Type: object

Property loadBalancerId: The ID of the ALB instance.


CaCertificatesOptional

public object CaCertificates { get; set; }
  • Type: object

Property caCertificates: List of configured CA certificates for listener.


CaEnabledOptional

public object CaEnabled { get; set; }
  • Type: object

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.


CertificatesOptional

public object Certificates { get; set; }
  • Type: object

Property certificates: The list of SSL certificates for listener.


GzipEnabledOptional

public object GzipEnabled { get; set; }
  • Type: object

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

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

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

Property listenerDescription: The description of the listener.

The description must be 2 to 256 characters in length.


ListenerStatusOptional

public object ListenerStatus { get; set; }
  • Type: object

Property listenerStatus: The status of the listener.


QuicConfigOptional

public object QuicConfig { get; set; }
  • Type: object

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


RequestTimeoutOptional

public object RequestTimeout { get; set; }
  • Type: object

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

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

Property xForwardedForConfig: The configuration of the XForward field.