Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkga"
&alicloudroscdkga.ListenerProps {
    AcceleratorId: interface{},
    PortRanges: interface{},
    Protocol: interface{},
    Certificates: interface{},
    ClientAffinity: interface{},
    Description: interface{},
    HttpVersion: interface{},
    IdleTimeout: interface{},
    Name: interface{},
    ProxyProtocol: interface{},
    RequestTimeout: interface{},
    SecurityPolicyId: interface{},
    Type: interface{},
    XForwardedForConfig: interface{},
}

Properties

Name Type Description
AcceleratorId interface{} Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.
PortRanges interface{} Property portRanges:.
Protocol interface{} Property protocol: The network transmission protocol of the listener.
Certificates interface{} Property certificates:.
ClientAffinity interface{} Property clientAffinity: Specifies whether to enable client affinity for the listener.
Description interface{} Property description: The description of the listener.
HttpVersion interface{} Property httpVersion: The maximum version of the HTTP protocol.
IdleTimeout interface{} Property idleTimeout: The connection idle timeout period.
Name interface{} Property name: The name of the listener.
ProxyProtocol interface{} Property proxyProtocol: Specifies whether to preserve client IP addresses.
RequestTimeout interface{} Property requestTimeout: The HTTP request timeout period.
SecurityPolicyId interface{} Property securityPolicyId: The ID of the security policy.
Type interface{} Property type: The listener routing type.
XForwardedForConfig interface{} Property xForwardedForConfig: The configuration of the XForward field.

AcceleratorIdRequired

AcceleratorId interface{}
  • Type: interface{}

Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.


PortRangesRequired

PortRanges interface{}
  • Type: interface{}

Property portRanges:.


ProtocolRequired

Protocol interface{}
  • Type: interface{}

Property protocol: The network transmission protocol of the listener.

Valid values: tcp: TCP protocol udp: UDP protocol http: HTTP protocolhttps: HTTPS protocol.


CertificatesOptional

Certificates interface{}
  • Type: interface{}

Property certificates:.


ClientAffinityOptional

ClientAffinity interface{}
  • Type: interface{}

Property clientAffinity: Specifies whether to enable client affinity for the listener.

If you do not specify the default value in the parameter, client affinity is disabled. When client affinity is disabled, the connections from a specific source (client) IP address are not always routed to the same endpoint. If you set the value to SOURCE_IP, client affinity is enabled. When client affinity is enabled, the connections from a specific source (client) IP address are always routed to the same endpoint.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: The description of the listener.


HttpVersionOptional

HttpVersion interface{}
  • Type: interface{}

Property httpVersion: The maximum version of the HTTP protocol.

Valid values: http1.1 http2 http3 Note Only HTTPS listeners support this parameter.


IdleTimeoutOptional

IdleTimeout interface{}
  • Type: interface{}

Property idleTimeout: The connection idle timeout period.

Unit: seconds. Valid values: TCP listener: 10 to 900 UDP listener: 10 to 20 HTTP or HTTPS listener: 1 to 60 Note Only listeners support this parameter.


NameOptional

Name interface{}
  • Type: interface{}

Property name: The name of the listener.

The name must be 2 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter or Chinese character.


ProxyProtocolOptional

ProxyProtocol interface{}
  • Type: interface{}

Property proxyProtocol: Specifies whether to preserve client IP addresses.

Valid values: true: preserves client IP addresses. After this feature is enabled, backend servers can retrieve client IP addresses. false (default): does not preserve client IP addresses.


RequestTimeoutOptional

RequestTimeout interface{}
  • Type: interface{}

Property requestTimeout: The HTTP request timeout period.

Unit: seconds. Valid values: 1 to 180. Default value: 60. Note Only HTTP and HTTPS listeners support this parameter.


SecurityPolicyIdOptional

SecurityPolicyId interface{}
  • Type: interface{}

Property securityPolicyId: The ID of the security policy.

Valid values: tls_cipher_policy_1_0 tls_cipher_policy_1_1 tls_cipher_policy_1_2 tls_cipher_policy_1_2_strict tls_cipher_policy_1_2_strict_with_1_3 Note Only HTTPS listeners support this parameter.


TypeOptional

Type interface{}
  • Type: interface{}

Property type: The listener routing type.

Valid values: Standard: the standard routing type CustomRouting: the custom routing type


XForwardedForConfigOptional

XForwardedForConfig interface{}
  • Type: interface{}

Property xForwardedForConfig: The configuration of the XForward field.