ListenerProps

Properties for defining a Listener.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkslb"
&alicloudroscdkslb.ListenerProps {
    Bandwidth: interface{},
    ListenerPort: interface{},
    LoadBalancerId: interface{},
    Protocol: interface{},
    AclId: interface{},
    AclIds: interface{},
    AclStatus: interface{},
    AclType: interface{},
    BackendServerPort: interface{},
    CaCertificateId: interface{},
    ConnectionDrain: interface{},
    ConnectionDrainTimeout: interface{},
    Description: interface{},
    EnableHttp2: interface{},
    Gzip: interface{},
    HealthCheck: interface{},
    HttpConfig: interface{},
    IdleTimeout: interface{},
    MasterSlaveServerGroupId: interface{},
    Persistence: interface{},
    PortRange: interface{},
    ProxyProtocolV2Enabled: interface{},
    RequestTimeout: interface{},
    Scheduler: interface{},
    ServerCertificateId: interface{},
    StartListener: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkslb.RosListener.TagsProperty,
    TlsCipherPolicy: interface{},
    VServerGroupId: interface{},
}

Properties

Name	Type	Description
Bandwidth	interface{}	Property bandwidth: The bandwidth of network, unit in Mbps(Million bits per second).
ListenerPort	interface{}	Property listenerPort: Port for front listener.
LoadBalancerId	interface{}	Property loadBalancerId: The id of load balancer to create listener.
Protocol	interface{}	Property protocol: The load balancer transport protocol to use for routing: http, https, tcp, or udp.
AclId	interface{}	Property aclId: The ID of the access control associated with the listener to be created.
AclIds	interface{}	Property aclIds: The ID list of the access controls associated with the listener to be created.
AclStatus	interface{}	Property aclStatus: Indicates whether to enable access control.
AclType	interface{}	Property aclType: The access control type: * white: Indicates a whitelist.
BackendServerPort	interface{}	Property backendServerPort: Backend server can listen on ports from 1 to 65535.
CaCertificateId	interface{}	Property caCertificateId: CA server certificate id, for https listener only.
ConnectionDrain	interface{}	Property connectionDrain: Whether to enable graceful connection interruption.
ConnectionDrainTimeout	interface{}	Property connectionDrainTimeout: Set the connection graceful interruption timeout.
Description	interface{}	Property description: The description of the listener.It must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (\/), periods (.), and underscores (_). Chinese characters are supported.
EnableHttp2	interface{}	Property enableHttp2: Specifies whether to use HTTP\/2.
Gzip	interface{}	Property gzip: Specifies whether to enable Gzip compression to compress specific types of files.
HealthCheck	interface{}	Property healthCheck: The properties of health checking setting.
HttpConfig	interface{}	Property httpConfig: Config for http protocol.
IdleTimeout	interface{}	Property idleTimeout: Specify the idle connection timeout in seconds.
MasterSlaveServerGroupId	interface{}	Property masterSlaveServerGroupId: The id of the MasterSlaveServerGroup which use in listener.
Persistence	interface{}	Property persistence: The properties of persistence.
PortRange	interface{}	Property portRange: Port range, only supports TCP or UDP listener.
ProxyProtocolV2Enabled	interface{}	Property proxyProtocolV2Enabled: Whether to support carrying the client source address to the backend server through the Proxy Protocol.
RequestTimeout	interface{}	Property requestTimeout: Specify the request timeout in seconds.
Scheduler	interface{}	Property scheduler: The scheduling algorithm.
ServerCertificateId	interface{}	Property serverCertificateId: Server certificate id, for https listener only, this properties is required.
StartListener	interface{}	Property startListener: Whether start listener after listener created.
Tags	*[]TagsProperty	Property tags: Tags to attach to instance.
TlsCipherPolicy	interface{}	Property tlsCipherPolicy: The Transport Layer Security (TLS) security policy.
VServerGroupId	interface{}	Property vServerGroupId: The id of the VServerGroup which use in listener.

---

Bandwidth^Required

Bandwidth interface{}

• Type: interface{}

Property bandwidth: The bandwidth of network, unit in Mbps(Million bits per second).

If the specified load balancer with "LOAD_BALANCE_ID" is charged by "paybybandwidth" and is created in classic network, each Listener's bandwidth must be greater than 0 and the sum of all of its Listeners' bandwidth can't be greater than the bandwidth of the load balancer.

---

ListenerPort^Required

ListenerPort interface{}

• Type: interface{}

Property listenerPort: Port for front listener.

Range from 0 to 65535.

---

LoadBalancerId^Required

LoadBalancerId interface{}

• Type: interface{}

Property loadBalancerId: The id of load balancer to create listener.

---

Protocol^Required

Protocol interface{}

• Type: interface{}

Property protocol: The load balancer transport protocol to use for routing: http, https, tcp, or udp.

---

AclId^Optional

AclId interface{}

• Type: interface{}

Property aclId: The ID of the access control associated with the listener to be created.

If the value of the AclStatus parameter is on, this parameter is required.

---

AclIds^Optional

AclIds interface{}

• Type: interface{}

Property aclIds: The ID list of the access controls associated with the listener to be created.

If the value of the AclStatus parameter is on, this parameter is required.AclIds have higher priority than AclId.

---

AclStatus^Optional

AclStatus interface{}

• Type: interface{}

Property aclStatus: Indicates whether to enable access control.

Valid values: on | off. Default value: off

---

AclType^Optional

AclType interface{}

• Type: interface{}

Property aclType: The access control type: * white: Indicates a whitelist.

Only requests from IP addresses or CIDR blocks in the selected access control lists are forwarded. This applies to scenarios in which an application only allows access from specific IP addresses. Enabling a whitelist poses some risks to your services. After a whitelist is enabled, only the IP addresses in the list can access the listener. If you enable a whitelist without adding any IP addresses in the list, no requests are forwarded.

• black: Indicates a blacklist. Requests from IP addresses or CIDR blocks in the selected access control lists are not forwarded (that is, they are blocked). This applies to scenarios in which an application only denies access from specific IP addresses. If you enable a blacklist without adding any IP addresses in the list, all requests are forwarded.

If the value of the AclStatus parameter is on, this parameter is required.

---

BackendServerPort^Optional

BackendServerPort interface{}

• Type: interface{}

Property backendServerPort: Backend server can listen on ports from 1 to 65535.

---

CaCertificateId^Optional

CaCertificateId interface{}

• Type: interface{}

Property caCertificateId: CA server certificate id, for https listener only.

---

ConnectionDrain^Optional

ConnectionDrain interface{}

• Type: interface{}

Property connectionDrain: Whether to enable graceful connection interruption.

Value:on: turn on off: Not turned on Note: Only effective TCP listener.

---

ConnectionDrainTimeout^Optional

ConnectionDrainTimeout interface{}

• Type: interface{}

Property connectionDrainTimeout: Set the connection graceful interruption timeout.

Unit: seconds. Value range: 10-900. Note: Only effective for TCP listener. When ConnectionDrain is on, this option is required.

---

Description^Optional

Description interface{}

• Type: interface{}

Property description: The description of the listener.It must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (\/), periods (.), and underscores (_). Chinese characters are supported.

---

EnableHttp2^Optional

EnableHttp2 interface{}

• Type: interface{}

Property enableHttp2: Specifies whether to use HTTP\/2.

It takes effect when Protocol=https. Valid values: on: yes off: no

---

Gzip^Optional

Gzip interface{}

• Type: interface{}

Property gzip: Specifies whether to enable Gzip compression to compress specific types of files.

Valid values: on (default): yes off: no

---

HealthCheck^Optional

HealthCheck interface{}

• Type: interface{}

Property healthCheck: The properties of health checking setting.

---

HttpConfig^Optional

HttpConfig interface{}

• Type: interface{}

Property httpConfig: Config for http protocol.

---

IdleTimeout^Optional

IdleTimeout interface{}

• Type: interface{}

Property idleTimeout: Specify the idle connection timeout in seconds.

Valid value: 1-60 If no request is received during the specified timeout period, Server Load Balancer will temporarily terminate the connection and restart the connection when the next request comes.

---

MasterSlaveServerGroupId^Optional

MasterSlaveServerGroupId interface{}

• Type: interface{}

Property masterSlaveServerGroupId: The id of the MasterSlaveServerGroup which use in listener.

---

Persistence^Optional

Persistence interface{}

• Type: interface{}

Property persistence: The properties of persistence.

---

PortRange^Optional

PortRange interface{}

• Type: interface{}

Property portRange: Port range, only supports TCP or UDP listener.

ListenerPort should be 0 when PortRange is specified.

---

ProxyProtocolV2Enabled^Optional

ProxyProtocolV2Enabled interface{}

• Type: interface{}

Property proxyProtocolV2Enabled: Whether to support carrying the client source address to the backend server through the Proxy Protocol.

Value: true: Yes false (default): No Note: Only effective TCP or UDP listener.

---

RequestTimeout^Optional

RequestTimeout interface{}

• Type: interface{}

Property requestTimeout: Specify the request timeout in seconds.

Valid value: 1-180 If no response is received from the backend server during the specified timeout period, Server Load Balancer will stop waiting and send an HTTP 504 error to the client.

---

Scheduler^Optional

Scheduler interface{}

• Type: interface{}

Property scheduler: The scheduling algorithm.

Valid values: wrr: Backend servers that have higher weights receive more requests than those that have lower weights. wlc: Requests are distributed based on the combination of the weights and connections to backend servers. If two backend servers have the same weight, the backend server that has fewer connections receives more requests. rr: Requests are distributed to backend servers in sequence. sch: specifies consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server. tch: specifies consistent hashing that is based on four factors: source IP address, destination IP address, source port number, and destination port number. Requests that contain the same preceding information are distributed to the same backend server. Default: wrr

---

ServerCertificateId^Optional

ServerCertificateId interface{}

• Type: interface{}

Property serverCertificateId: Server certificate id, for https listener only, this properties is required.

---

StartListener^Optional

StartListener interface{}

• Type: interface{}

Property startListener: Whether start listener after listener created.

Default True.

---

Tags^Optional

Tags *[]TagsProperty

• Type: *[]TagsProperty

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

TlsCipherPolicy^Optional

TlsCipherPolicy interface{}

• Type: interface{}

Property tlsCipherPolicy: The Transport Layer Security (TLS) security policy.

Each security policy contains TLS protocol versions and cipher suites available for HTTPS. It takes effect when Protocol=https.

---

VServerGroupId^Optional

VServerGroupId interface{}

• Type: interface{}

Property vServerGroupId: The id of the VServerGroup which use in listener.

---