ListenerArgs

the id of access control list to be apply on the listener, is the id of resource alicloud_slb_acl. If acl_status is "on", it is mandatory. Otherwise, it will be ignored.

Whether to enable "acl(access control list)", the acl is specified by acl_id. Valid values are on and off. Default to off.

Mode for handling the acl specified by acl_id. If acl_status is "on", it is mandatory. Otherwise, it will be ignored. Valid values are white and black. white means the Listener can only be accessed by client ip belongs to the acl; black means the Listener can not be accessed by client ip belongs to the acl.

Port used by the Server Load Balancer instance backend. Valid value range: 1-65535.

Bandwidth peak of Listener. For the public network instance charged per traffic consumed, the Bandwidth on Listener can be set to -1, indicating the bandwidth peak is unlimited. Valid values are -1, 1-1000 in Mbps.

SLB CA certificate ID. Only when protocol is https can be specified.

The cookie configured on the server. It is mandatory when sticky_session is "on" and sticky_session_type is "server". Otherwise, it will be ignored. Valid value：String in line with RFC 2965, with length being 1- 200. It only contains characters such as ASCII codes, English letters and digits instead of the comma, semicolon or spacing, and it cannot start with $.

Cookie timeout. It is mandatory when sticky_session is "on" and sticky_session_type is "insert". Otherwise, it will be ignored. Valid value range: 1-86400 in seconds.

Checking DeleteProtection of SLB instance before deleting. If true, this resource will not be deleted when its SLB instance enabled DeleteProtection. Default to false.

The description of slb listener. This description can have a string of 1 to 80 characters. Default value: null.

Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.

Timeout of tcp listener established connection idle timeout. Valid value range: 10-900 in seconds. Default to 900.

The port that http redirect to https.

Port used by the Server Load Balancer instance frontend. Valid value range: 1-65535.

Whether to enable "Gzip Compression". If enabled, files of specific file types will be compressed, otherwise, no files will be compressed. Default to true. Available since v1.13.0+.

Whether to enable health check. Valid values areon and off. TCP and UDP listener's HealthCheck is always on, so it will be ignore when launching TCP or UDP listener.

The port that is used for health checks. Valid value range: 0-65535. Default to 0 means that the port on a backend server is used for health checks.

Domain name used for health check. When it used to launch TCP listener, health_check_type must be "http". Its length is limited to 1-80 and only characters such as letters, digits, ‘-‘ and ‘.’ are allowed. When it is not set or empty, Server Load Balancer uses the private network IP address of each backend server as Domain used for health check.

Regular health check HTTP status code. Multiple codes are segmented by “,”. It is required when health_check is on. Default to http_2xx. Valid values are: http_2xx, http_3xx, http_4xx and http_5xx.

Time interval of health checks. It is required when health_check is on. Valid value range: 1-50 in seconds. Default to 2.

HealthCheckMethod used for health check.Valid values: "head", "get" http and https support regions ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, us-east-1, us-west-1, eu-central-1, ap-south-1, me-east-1, cn-huhehaote, cn-zhangjiakou, ap-southeast-5, cn-shenzhen, cn-hongkong, cn-qingdao, cn-chengdu, eu-west-1, cn-hangzhou", cn-beijing, cn-shanghai.This function does not support the TCP protocol .

Maximum timeout of each health check response. It is required when health_check is on. Valid value range: 1-300 in seconds. Default to 5. Note: If health_check_timeout<health_check_interval, its will be replaced by health_check_interval.

Type of health check. Valid values are: tcp and http. Default to tcp . TCP supports TCP and HTTP health check mode, you can select the particular mode depending on your application.

URI used for health check. When it used to launch TCP listener, health_check_type must be "http". Its length is limited to 1-80 and it must start with /. Only characters such as letters, digits, ‘-’, ‘/’, ‘.’, ‘%’, ‘?’, #’ and ‘&’ are allowed.

The number of health checks that an unhealthy backend server must consecutively pass before it can be declared healthy. In this case, the health check state is changed from fail to success. It is required when health_check is on. Valid value range: 2-10 in seconds. Default to 3. NOTE: This parameter takes effect only if the health_check parameter is set to on.

Timeout of http or https listener established connection idle timeout. Valid value range: 1-60 in seconds. Default to 15.

Whether to enable http redirect to https, Valid values are on and off. Default to off.

The Load Balancer ID which is used to launch a new listener.

The ID of the master slave server group.

Timeout of connection persistence. Valid value range: 0-3600 in seconds. Default to 0 and means closing it.

The protocol to listen on. Valid values are `http`, `https`, `tcp`, `udp`.

Whether to support carrying the client source address to the backend server through the Proxy Protocol. Valid values are true and false. Default to false.

Timeout of http or https listener request (which does not get response from backend) timeout. Valid value range: 1-180 in seconds. Default to 60.

Scheduling algorithm, Valid values: wrr, rr, wlc, sch, tcp, qch. Default to wrr. Only when protocol is tcp or udp, scheduler can be set to sch. Only when instance is guaranteed-performance instance and protocol is tcp or udp, scheduler can be set to tch. Only when instance is guaranteed-performance instance and protocol is udp, scheduler can be set to qch.

SLB Server certificate ID. It is required when protocol is https. The server_certificate_id is also required when the value of the ssl_certificate_id is Empty.

the id of server group to be apply on the listener, is the id of resource alicloud.slb.ServerGroup.

SLB Server certificate ID. It has been deprecated from 1.59.0 and using server_certificate_id instead.

Whether to enable session persistence, Valid values are on and off. Default to off.

Mode for handling the cookie. If sticky_session is "on", it is mandatory. Otherwise, it will be ignored. Valid values are insert and server. insert means it is inserted from Server Load Balancer; server means the Server Load Balancer learns from the backend server.

Https listener TLS cipher policy. Valid values are tls_cipher_policy_1_0, tls_cipher_policy_1_1, tls_cipher_policy_1_2, tls_cipher_policy_1_2_strict. Default to tls_cipher_policy_1_0. Currently the tls_cipher_policy can not be updated when load balancer instance is "Shared-Performance".

The number of health checks that a healthy backend server must consecutively fail before it can be declared unhealthy. In this case, the health check state is changed from success to fail. It is required when health_check is on. Valid value range: 2-10 in seconds. Default to 3. NOTE: This parameter takes effect only if the health_check parameter is set to on.

Whether to set additional HTTP Header field "X-Forwarded-For" (documented below). Available since v1.13.0+. See x_forwarded_for below.