Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ga;
new ListenerProps {
    object AcceleratorId,
    object PortRanges,
    object Protocol,
    object Certificates = null,
    object ClientAffinity = null,
    object Description = null,
    object Name = null,
    object ProxyProtocol = null,
    object SecurityPolicyId = null,
    object XForwardedForConfig = null
};

Properties

Name Type Description
AcceleratorId object Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.
PortRanges object Property portRanges:.
Protocol object Property protocol: The network transmission protocol of the listener.
Certificates object Property certificates:.
ClientAffinity object Property clientAffinity: Specifies whether to enable client affinity for the listener.
Description object Property description: The description of the listener.
Name object Property name: The name of the listener.
ProxyProtocol object Property proxyProtocol: Specifies whether to preserve client IP addresses.
SecurityPolicyId object Property securityPolicyId: The ID of the security policy.
XForwardedForConfig object Property xForwardedForConfig: The configuration of the XForward field.

AcceleratorIdRequired

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

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


PortRangesRequired

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

Property portRanges:.


ProtocolRequired

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

Property protocol: The network transmission protocol of the listener.

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


CertificatesOptional

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

Property certificates:.


ClientAffinityOptional

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

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

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

Property description: The description of the listener.


NameOptional

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

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

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

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.


SecurityPolicyIdOptional

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

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.


XForwardedForConfigOptional

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

Property xForwardedForConfig: The configuration of the XForward field.