Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkalb"
&alicloudroscdkalb.ListenerProps {
    DefaultActions: interface{},
    ListenerPort: interface{},
    ListenerProtocol: interface{},
    LoadBalancerId: interface{},
    CaCertificates: interface{},
    CaEnabled: interface{},
    Certificates: interface{},
    GzipEnabled: interface{},
    Http2Enabled: interface{},
    IdleTimeout: interface{},
    ListenerDescription: interface{},
    ListenerStatus: interface{},
    LogConfig: interface{},
    QuicConfig: interface{},
    RequestTimeout: interface{},
    SecurityPolicyId: interface{},
    XForwardedForConfig: interface{},
}

Properties

Name Type Description
DefaultActions interface{} Property defaultActions: The default actions for the listener.
ListenerPort interface{} Property listenerPort: The frontend port that is used by the ALB instance.
ListenerProtocol interface{} Property listenerProtocol: The listener protocol.
LoadBalancerId interface{} Property loadBalancerId: The ID of the ALB instance.
CaCertificates interface{} Property caCertificates: A list of CA certificates for the listener.
CaEnabled interface{} Property caEnabled: Specifies whether to enable mutual authentication.
Certificates interface{} Property certificates: A list of server certificates.
GzipEnabled interface{} Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.
Http2Enabled interface{} Property http2Enabled: Specifies whether to enable HTTP\/2.
IdleTimeout interface{} Property idleTimeout: The idle timeout in seconds.
ListenerDescription interface{} Property listenerDescription: A custom name for the listener.
ListenerStatus interface{} Property listenerStatus: The status of the listener.
LogConfig interface{} Property logConfig: The configuration information about the access log.
QuicConfig interface{} Property quicConfig: Select a QUIC listener and associate it with the ALB instance.
RequestTimeout interface{} Property requestTimeout: The request timeout in seconds.
SecurityPolicyId interface{} Property securityPolicyId: The ID of the security policy.
XForwardedForConfig interface{} Property xForwardedForConfig: The configuration of X-Forwarded-* headers.

DefaultActionsRequired

DefaultActions interface{}
  • Type: interface{}

Property defaultActions: The default actions for the listener.


ListenerPortRequired

ListenerPort interface{}
  • Type: interface{}

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

Valid values: 1 to 65535.


ListenerProtocolRequired

ListenerProtocol interface{}
  • Type: interface{}

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.


LoadBalancerIdRequired

LoadBalancerId interface{}
  • Type: interface{}

Property loadBalancerId: The ID of the ALB instance.


CaCertificatesOptional

CaCertificates interface{}
  • Type: interface{}

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

Only one CA certificate is supported.


CaEnabledOptional

CaEnabled interface{}
  • Type: interface{}

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.


CertificatesOptional

Certificates interface{}
  • Type: interface{}

Property certificates: A list of server certificates.


GzipEnabledOptional

GzipEnabled interface{}
  • Type: interface{}

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

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


Http2EnabledOptional

Http2Enabled interface{}
  • Type: interface{}

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

IdleTimeout interface{}
  • Type: interface{}

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.


ListenerDescriptionOptional

ListenerDescription interface{}
  • Type: interface{}

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.


ListenerStatusOptional

ListenerStatus interface{}
  • Type: interface{}

Property listenerStatus: The status of the listener.


LogConfigOptional

LogConfig interface{}
  • Type: interface{}

Property logConfig: The configuration information about the access log.


QuicConfigOptional

QuicConfig interface{}
  • Type: interface{}

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


RequestTimeoutOptional

RequestTimeout interface{}
  • Type: interface{}

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.


SecurityPolicyIdOptional

SecurityPolicyId interface{}
  • Type: interface{}

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

XForwardedForConfig interface{}
  • Type: interface{}

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