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)
// .httpVersion(java.lang.String)
// .httpVersion(IResolvable)
// .idleTimeout(java.lang.Number)
// .idleTimeout(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .proxyProtocol(java.lang.Boolean)
// .proxyProtocol(IResolvable)
// .requestTimeout(java.lang.Number)
// .requestTimeout(IResolvable)
// .securityPolicyId(java.lang.String)
// .securityPolicyId(IResolvable)
// .type(java.lang.String)
// .type(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.List | 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.List | 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. |
httpVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property httpVersion: The maximum version of the HTTP protocol. |
idleTimeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property idleTimeout: The connection idle timeout period. |
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. |
requestTimeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property requestTimeout: The HTTP request timeout period. |
securityPolicyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityPolicyId: The ID of the security policy. |
type | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property type: The listener routing type. |
xForwardedForConfig | com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty | Property xForwardedForConfig: The configuration of the XForward field. |
acceleratorIdRequired
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.
portRangesRequired
public java.lang.Object getPortRanges();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
PortRangesProperty>
Property portRanges:.
protocolRequired
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.
certificatesOptional
public java.lang.Object getCertificates();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
CertificatesProperty>
Property certificates:.
clientAffinityOptional
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.
descriptionOptional
public java.lang.Object getDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the listener.
httpVersionOptional
public java.lang.Object getHttpVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property httpVersion: The maximum version of the HTTP protocol.
Valid values: http1.1 http2 http3 Note Only HTTPS listeners support this parameter.
idleTimeoutOptional
public java.lang.Object getIdleTimeout();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
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
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.
proxyProtocolOptional
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.
requestTimeoutOptional
public java.lang.Object getRequestTimeout();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
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
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.
typeOptional
public java.lang.Object getType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property type: The listener routing type.
Valid values: Standard: the standard routing type CustomRouting: the custom routing type
xForwardedForConfigOptional
public java.lang.Object getXForwardedForConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable OR XForwardedForConfigProperty
Property xForwardedForConfig: The configuration of the XForward field.