ListenerProps

Properties for defining a Listener.

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

Initializer

import com.aliyun.ros.cdk.ga.ListenerProps;
ListenerProps.builder()
    .acceleratorId(java.lang.String)
    .acceleratorId(IResolvable)
    .portRanges(IResolvable)
    .portRanges(java.util.List<IResolvable)
    .portRanges(PortRangesProperty>)
    .protocol(java.lang.String)
    .protocol(IResolvable)
//  .certificates(IResolvable)
//  .certificates(java.util.List<IResolvable)
//  .certificates(CertificatesProperty>)
//  .clientAffinity(java.lang.String)
//  .clientAffinity(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .proxyProtocol(java.lang.Boolean)
//  .proxyProtocol(IResolvable)
//  .securityPolicyId(java.lang.String)
//  .securityPolicyId(IResolvable)
//  .xForwardedForConfig(IResolvable)
//  .xForwardedForConfig(XForwardedForConfigProperty)
    .build();

Properties

Name	Type	Description
acceleratorId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property acceleratorId: The ID of the Global Accelerator instance to which the listener will be added.
portRanges	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPortRangesProperty>	Property portRanges:.
protocol	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property protocol: The network transmission protocol of the listener.
certificates	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListCertificatesProperty>	Property certificates:.
clientAffinity	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property clientAffinity: Specifies whether to enable client affinity for the listener.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of the listener.
name	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property name: The name of the listener.
proxyProtocol	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property proxyProtocol: Specifies whether to preserve client IP addresses.
securityPolicyId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property securityPolicyId: The ID of the security policy.
xForwardedForConfig	com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty	Property xForwardedForConfig: The configuration of the XForward field.

---

acceleratorId^Required

public java.lang.Object getAcceleratorId();

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

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

---

portRanges^Required

public java.lang.Object getPortRanges();

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

Property portRanges:.

---

protocol^Required

public java.lang.Object getProtocol();

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

Property protocol: The network transmission protocol of the listener.

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

---

certificates^Optional

public java.lang.Object getCertificates();

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

Property certificates:.

---

clientAffinity^Optional

public java.lang.Object getClientAffinity();

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

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.

---

description^Optional

public java.lang.Object getDescription();

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

Property description: The description of the listener.

---

name^Optional

public java.lang.Object getName();

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

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.

---

proxyProtocol^Optional

public java.lang.Object getProxyProtocol();

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

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.

---

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.

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.

---

xForwardedForConfig^Optional

public java.lang.Object getXForwardedForConfig();

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

Property xForwardedForConfig: The configuration of the XForward field.

---