1. Docs
  2. Reference
  3. API
  4. AliCloud
  5. slb
  6. Listener

Listener

Provides an Application Load Balancer Listener resource.

For information about slb and how to use it, see What is Server Load Balancer.

For information about listener and how to use it, to see the following:

load balance support 4 protocal to listen on, they are http,https,tcp,udp, the every listener support which portocal following:

listener parametersupport protocolvalue range
backend_porthttp & https & tcp & udp1-65535
frontend_porthttp & https & tcp & udp1-65535
protocolhttp & https & tcp & udp
bandwidthhttp & https & tcp & udp-1 / 1-1000
schedulerhttp & https & tcp & udpwrr rr or wlc
sticky_sessionhttp & httpson or off
sticky_session_typehttp & httpsinsert or server
cookie_timeouthttp & https1-86400
cookiehttp & https
persistence_timeouttcp & udp0-3600
health_checkhttp & httpson or off
health_check_typetcptcp or http
health_check_domainhttp & https & tcp
health_check_methodhttp & https & tcp
health_check_urihttp & https & tcp
health_check_connect_porthttp & https & tcp & udp1-65535 or -520
healthy_thresholdhttp & https & tcp & udp1-10
unhealthy_thresholdhttp & https & tcp & udp1-10
health_check_timeouthttp & https & tcp & udp1-300
health_check_intervalhttp & https & tcp & udp1-50
health_check_http_codehttp & https & tcphttp_2xx,http_3xx,http_4xx,http_5xx
server_certificate_idhttps
gziphttp & httpstrue or false
x_forwarded_forhttp & https
acl_statushttp & https & tcp & udpon or off
acl_typehttp & https & tcp & udpwhite or black
acl_idhttp & https & tcp & udpthe id of resource alicloud_slb_acl
established_timeouttcp10-900
idle_timeouthttp & https1-60
request_timeouthttp & https1-180
enable_http2httpson or off
tls_cipher_policyhttpstls_cipher_policy_1_0, tls_cipher_policy_1_1, tls_cipher_policy_1_2, tls_cipher_policy_1_2_strict
server_group_idhttp & https & tcp & udpthe id of resource alicloud.slb.ServerGroup

The listener mapping supports the following:

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var name = config.Get("name") ?? "testcreatehttplistener";
        var ipVersion = config.Get("ipVersion") ?? "ipv4";
        var defaultLoadBalancer = new AliCloud.Slb.LoadBalancer("defaultLoadBalancer", new AliCloud.Slb.LoadBalancerArgs
        {
            Internet = true,
            InternetChargeType = "PayByTraffic",
        });
        var defaultAcl = new AliCloud.Slb.Acl("defaultAcl", new AliCloud.Slb.AclArgs
        {
            EntryLists = 
            {
                new AliCloud.Slb.Inputs.AclEntryListArgs
                {
                    Comment = "first",
                    Entry = "10.10.10.0/24",
                },
                new AliCloud.Slb.Inputs.AclEntryListArgs
                {
                    Comment = "second",
                    Entry = "168.10.10.0/24",
                },
            },
            IpVersion = ipVersion,
        });
        var defaultListener = new AliCloud.Slb.Listener("defaultListener", new AliCloud.Slb.ListenerArgs
        {
            AclId = defaultAcl.Id,
            AclStatus = "on",
            AclType = "white",
            BackendPort = 80,
            Bandwidth = 10,
            Cookie = "testslblistenercookie",
            CookieTimeout = 86400,
            FrontendPort = 80,
            HealthCheck = "on",
            HealthCheckConnectPort = 20,
            HealthCheckDomain = "ali.com",
            HealthCheckHttpCode = "http_2xx,http_3xx",
            HealthCheckInterval = 5,
            HealthCheckTimeout = 8,
            HealthCheckUri = "/cons",
            HealthyThreshold = 8,
            IdleTimeout = 30,
            LoadBalancerId = defaultLoadBalancer.Id,
            Protocol = "http",
            RequestTimeout = 80,
            StickySession = "on",
            StickySessionType = "insert",
            UnhealthyThreshold = 8,
            XForwardedFor = new AliCloud.Slb.Inputs.ListenerXForwardedForArgs
            {
                RetriveSlbId = true,
                RetriveSlbIp = true,
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "testcreatehttplistener"
ip_version = config.get("ipVersion")
if ip_version is None:
    ip_version = "ipv4"
default_load_balancer = alicloud.slb.LoadBalancer("defaultLoadBalancer",
    internet=True,
    internet_charge_type="PayByTraffic")
default_acl = alicloud.slb.Acl("defaultAcl",
    entry_lists=[
        {
            "comment": "first",
            "entry": "10.10.10.0/24",
        },
        {
            "comment": "second",
            "entry": "168.10.10.0/24",
        },
    ],
    ip_version=ip_version)
default_listener = alicloud.slb.Listener("defaultListener",
    acl_id=default_acl.id,
    acl_status="on",
    acl_type="white",
    backend_port=80,
    bandwidth=10,
    cookie="testslblistenercookie",
    cookie_timeout=86400,
    frontend_port=80,
    health_check="on",
    health_check_connect_port=20,
    health_check_domain="ali.com",
    health_check_http_code="http_2xx,http_3xx",
    health_check_interval=5,
    health_check_timeout=8,
    health_check_uri="/cons",
    healthy_threshold=8,
    idle_timeout=30,
    load_balancer_id=default_load_balancer.id,
    protocol="http",
    request_timeout=80,
    sticky_session="on",
    sticky_session_type="insert",
    unhealthy_threshold=8,
    x_forwarded_for={
        "retriveSlbId": True,
        "retriveSlbIp": True,
    })
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "testcreatehttplistener";
const ipVersion = config.get("ipVersion") || "ipv4";

const defaultLoadBalancer = new alicloud.slb.LoadBalancer("default", {
    internet: true,
    internetChargeType: "PayByTraffic",
});
const defaultAcl = new alicloud.slb.Acl("default", {
    entryLists: [
        {
            comment: "first",
            entry: "10.10.10.0/24",
        },
        {
            comment: "second",
            entry: "168.10.10.0/24",
        },
    ],
    ipVersion: ipVersion,
});
const defaultListener = new alicloud.slb.Listener("default", {
    aclId: defaultAcl.id,
    aclStatus: "on",
    aclType: "white",
    backendPort: 80,
    bandwidth: 10,
    cookie: "testslblistenercookie",
    cookieTimeout: 86400,
    frontendPort: 80,
    healthCheck: "on",
    healthCheckConnectPort: 20,
    healthCheckDomain: "ali.com",
    healthCheckHttpCode: "http_2xx,http_3xx",
    healthCheckInterval: 5,
    healthCheckTimeout: 8,
    healthCheckUri: "/cons",
    healthyThreshold: 8,
    idleTimeout: 30,
    loadBalancerId: defaultLoadBalancer.id,
    protocol: "http",
    requestTimeout: 80,
    stickySession: "on",
    stickySessionType: "insert",
    unhealthyThreshold: 8,
    xForwardedFor: {
        retriveSlbId: true,
        retriveSlbIp: true,
    },
});

Create a Listener Resource

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);
def Listener(resource_name, opts=None, acl_id=None, acl_status=None, acl_type=None, backend_port=None, bandwidth=None, cookie=None, cookie_timeout=None, delete_protection_validation=None, description=None, enable_http2=None, established_timeout=None, forward_port=None, frontend_port=None, gzip=None, health_check=None, health_check_connect_port=None, health_check_domain=None, health_check_http_code=None, health_check_interval=None, health_check_method=None, health_check_timeout=None, health_check_type=None, health_check_uri=None, healthy_threshold=None, idle_timeout=None, instance_port=None, lb_port=None, lb_protocol=None, listener_forward=None, load_balancer_id=None, master_slave_server_group_id=None, persistence_timeout=None, protocol=None, request_timeout=None, scheduler=None, server_certificate_id=None, server_group_id=None, ssl_certificate_id=None, sticky_session=None, sticky_session_type=None, tls_cipher_policy=None, unhealthy_threshold=None, x_forwarded_for=None, __props__=None);
func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Listener Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Listener resource accepts the following input properties:

FrontendPort int

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

LoadBalancerId string

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

Protocol string

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

AclId string

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.

AclStatus string

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

AclType string

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.

BackendPort int

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

Bandwidth int

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.

Cookie string

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 $.

CookieTimeout int

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.

DeleteProtectionValidation bool

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

Description string

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

EnableHttp2 string

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

EstablishedTimeout int

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

ForwardPort int

The port that http redirect to https.

Gzip bool

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 in v1.13.0+.

HealthCheck string

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.

HealthCheckConnectPort int

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

HealthCheckDomain string

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.

HealthCheckHttpCode string

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.

HealthCheckInterval int

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

HealthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

HealthCheckTimeout int

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.

HealthCheckType string

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.

HealthCheckUri string

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.

HealthyThreshold int

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

IdleTimeout int

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

InstancePort int

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

LbPort int

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

LbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

ListenerForward string

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

MasterSlaveServerGroupId string
PersistenceTimeout int

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

RequestTimeout int

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.

Scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

ServerCertificateId string

SLB Server certificate ID. It is required when protocol is https.

ServerGroupId string

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

SslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

StickySession string

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

StickySessionType string

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.

TlsCipherPolicy string

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”.

UnhealthyThreshold int

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

XForwardedFor Pulumi.AliCloud.Slb.Inputs.ListenerXForwardedForArgs

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

FrontendPort int

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

LoadBalancerId string

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

Protocol string

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

AclId string

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.

AclStatus string

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

AclType string

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.

BackendPort int

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

Bandwidth int

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.

Cookie string

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 $.

CookieTimeout int

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.

DeleteProtectionValidation bool

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

Description string

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

EnableHttp2 string

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

EstablishedTimeout int

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

ForwardPort int

The port that http redirect to https.

Gzip bool

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 in v1.13.0+.

HealthCheck string

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.

HealthCheckConnectPort int

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

HealthCheckDomain string

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.

HealthCheckHttpCode string

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.

HealthCheckInterval int

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

HealthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

HealthCheckTimeout int

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.

HealthCheckType string

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.

HealthCheckUri string

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.

HealthyThreshold int

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

IdleTimeout int

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

InstancePort int

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

LbPort int

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

LbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

ListenerForward string

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

MasterSlaveServerGroupId string
PersistenceTimeout int

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

RequestTimeout int

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.

Scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

ServerCertificateId string

SLB Server certificate ID. It is required when protocol is https.

ServerGroupId string

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

SslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

StickySession string

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

StickySessionType string

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.

TlsCipherPolicy string

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”.

UnhealthyThreshold int

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

XForwardedFor ListenerXForwardedFor

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

frontendPort number

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

loadBalancerId string

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

protocol string

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

aclId string

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.

aclStatus string

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

aclType string

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.

backendPort number

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

bandwidth number

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.

cookie string

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 $.

cookieTimeout number

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.

deleteProtectionValidation boolean

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

description string

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

enableHttp2 string

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

establishedTimeout number

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

forwardPort number

The port that http redirect to https.

gzip boolean

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 in v1.13.0+.

healthCheck string

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.

healthCheckConnectPort number

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

healthCheckDomain string

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.

healthCheckHttpCode string

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.

healthCheckInterval number

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

healthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

healthCheckTimeout number

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.

healthCheckType string

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.

healthCheckUri string

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.

healthyThreshold number

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

idleTimeout number

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

instancePort number

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

lbPort number

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

lbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

listenerForward string

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

masterSlaveServerGroupId string
persistenceTimeout number

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

requestTimeout number

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.

scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

serverCertificateId string

SLB Server certificate ID. It is required when protocol is https.

serverGroupId string

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

sslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

stickySession string

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

stickySessionType string

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.

tlsCipherPolicy string

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”.

unhealthyThreshold number

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

xForwardedFor ListenerXForwardedFor

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

frontend_port float

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

load_balancer_id str

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

protocol str

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

acl_id str

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.

acl_status str

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

acl_type str

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.

backend_port float

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

bandwidth float

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.

cookie str

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 float

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.

delete_protection_validation bool

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

description str

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

enable_http2 str

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

established_timeout float

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

forward_port float

The port that http redirect to https.

gzip bool

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 in v1.13.0+.

health_check str

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.

health_check_connect_port float

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

health_check_domain str

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.

health_check_http_code str

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.

health_check_interval float

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

health_check_method str

The method of health check. Valid values: [“head”, “get”].

health_check_timeout float

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.

health_check_type str

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.

health_check_uri str

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.

healthy_threshold float

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

idle_timeout float

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

instance_port float

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

lb_port float

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

lb_protocol str

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

listener_forward str

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

master_slave_server_group_id str
persistence_timeout float

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

request_timeout float

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.

scheduler str

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

server_certificate_id str

SLB Server certificate ID. It is required when protocol is https.

server_group_id str

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

ssl_certificate_id str

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

sticky_session str

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

sticky_session_type str

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.

tls_cipher_policy str

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”.

unhealthy_threshold float

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

x_forwarded_for Dict[ListenerXForwardedFor]

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

Outputs

All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Listener Resource

Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener
static get(resource_name, id, opts=None, acl_id=None, acl_status=None, acl_type=None, backend_port=None, bandwidth=None, cookie=None, cookie_timeout=None, delete_protection_validation=None, description=None, enable_http2=None, established_timeout=None, forward_port=None, frontend_port=None, gzip=None, health_check=None, health_check_connect_port=None, health_check_domain=None, health_check_http_code=None, health_check_interval=None, health_check_method=None, health_check_timeout=None, health_check_type=None, health_check_uri=None, healthy_threshold=None, idle_timeout=None, instance_port=None, lb_port=None, lb_protocol=None, listener_forward=None, load_balancer_id=None, master_slave_server_group_id=None, persistence_timeout=None, protocol=None, request_timeout=None, scheduler=None, server_certificate_id=None, server_group_id=None, ssl_certificate_id=None, sticky_session=None, sticky_session_type=None, tls_cipher_policy=None, unhealthy_threshold=None, x_forwarded_for=None, __props__=None);
func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AclId string

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.

AclStatus string

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

AclType string

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.

BackendPort int

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

Bandwidth int

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.

Cookie string

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 $.

CookieTimeout int

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.

DeleteProtectionValidation bool

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

Description string

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

EnableHttp2 string

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

EstablishedTimeout int

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

ForwardPort int

The port that http redirect to https.

FrontendPort int

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

Gzip bool

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 in v1.13.0+.

HealthCheck string

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.

HealthCheckConnectPort int

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

HealthCheckDomain string

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.

HealthCheckHttpCode string

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.

HealthCheckInterval int

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

HealthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

HealthCheckTimeout int

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.

HealthCheckType string

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.

HealthCheckUri string

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.

HealthyThreshold int

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

IdleTimeout int

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

InstancePort int

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

LbPort int

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

LbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

ListenerForward string

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

LoadBalancerId string

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

MasterSlaveServerGroupId string
PersistenceTimeout int

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

Protocol string

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

RequestTimeout int

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.

Scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

ServerCertificateId string

SLB Server certificate ID. It is required when protocol is https.

ServerGroupId string

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

SslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

StickySession string

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

StickySessionType string

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.

TlsCipherPolicy string

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”.

UnhealthyThreshold int

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

XForwardedFor Pulumi.AliCloud.Slb.Inputs.ListenerXForwardedForArgs

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

AclId string

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.

AclStatus string

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

AclType string

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.

BackendPort int

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

Bandwidth int

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.

Cookie string

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 $.

CookieTimeout int

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.

DeleteProtectionValidation bool

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

Description string

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

EnableHttp2 string

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

EstablishedTimeout int

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

ForwardPort int

The port that http redirect to https.

FrontendPort int

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

Gzip bool

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 in v1.13.0+.

HealthCheck string

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.

HealthCheckConnectPort int

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

HealthCheckDomain string

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.

HealthCheckHttpCode string

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.

HealthCheckInterval int

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

HealthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

HealthCheckTimeout int

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.

HealthCheckType string

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.

HealthCheckUri string

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.

HealthyThreshold int

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

IdleTimeout int

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

InstancePort int

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

LbPort int

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

LbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

ListenerForward string

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

LoadBalancerId string

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

MasterSlaveServerGroupId string
PersistenceTimeout int

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

Protocol string

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

RequestTimeout int

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.

Scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

ServerCertificateId string

SLB Server certificate ID. It is required when protocol is https.

ServerGroupId string

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

SslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

StickySession string

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

StickySessionType string

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.

TlsCipherPolicy string

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”.

UnhealthyThreshold int

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

XForwardedFor ListenerXForwardedFor

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

aclId string

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.

aclStatus string

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

aclType string

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.

backendPort number

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

bandwidth number

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.

cookie string

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 $.

cookieTimeout number

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.

deleteProtectionValidation boolean

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

description string

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

enableHttp2 string

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

establishedTimeout number

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

forwardPort number

The port that http redirect to https.

frontendPort number

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

gzip boolean

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 in v1.13.0+.

healthCheck string

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.

healthCheckConnectPort number

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

healthCheckDomain string

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.

healthCheckHttpCode string

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.

healthCheckInterval number

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

healthCheckMethod string

The method of health check. Valid values: [“head”, “get”].

healthCheckTimeout number

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.

healthCheckType string

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.

healthCheckUri string

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.

healthyThreshold number

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

idleTimeout number

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

instancePort number

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

lbPort number

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

lbProtocol string

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

listenerForward string

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

loadBalancerId string

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

masterSlaveServerGroupId string
persistenceTimeout number

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

protocol string

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

requestTimeout number

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.

scheduler string

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

serverCertificateId string

SLB Server certificate ID. It is required when protocol is https.

serverGroupId string

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

sslCertificateId string

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

stickySession string

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

stickySessionType string

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.

tlsCipherPolicy string

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”.

unhealthyThreshold number

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

xForwardedFor ListenerXForwardedFor

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

acl_id str

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.

acl_status str

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

acl_type str

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.

backend_port float

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

bandwidth float

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.

cookie str

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 float

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.

delete_protection_validation bool

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

description str

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

enable_http2 str

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

established_timeout float

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

forward_port float

The port that http redirect to https.

frontend_port float

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

gzip bool

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 in v1.13.0+.

health_check str

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.

health_check_connect_port float

Port used for health check. Valid value range: [1-65535]. Default to “None” means the backend server port is used.

health_check_domain str

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.

health_check_http_code str

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.

health_check_interval float

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

health_check_method str

The method of health check. Valid values: [“head”, “get”].

health_check_timeout float

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.

health_check_type str

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.

health_check_uri str

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.

healthy_threshold float

Threshold determining the result of the health check is success. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

idle_timeout float

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

instance_port float

Deprecated: Field 'instance_port' has been deprecated, and using 'backend_port' to replace.

lb_port float

Deprecated: Field 'lb_port' has been deprecated, and using 'frontend_port' to replace.

lb_protocol str

Deprecated: Field 'lb_protocol' has been deprecated, and using 'protocol' to replace.

listener_forward str

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

load_balancer_id str

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

master_slave_server_group_id str
persistence_timeout float

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

protocol str

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

request_timeout float

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.

scheduler str

Scheduling algorithm, Valid values are wrr, rr and wlc. Default to “wrr”.

server_certificate_id str

SLB Server certificate ID. It is required when protocol is https.

server_group_id str

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

ssl_certificate_id str

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Deprecated: Field 'ssl_certificate_id' has been deprecated from 1.59.0 and using 'server_certificate_id' instead.

sticky_session str

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

sticky_session_type str

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.

tls_cipher_policy str

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”.

unhealthy_threshold float

Threshold determining the result of the health check is fail. It is required when health_check is on. Valid value range: [1-10] in seconds. Default to 3.

x_forwarded_for Dict[ListenerXForwardedFor]

Whether to set additional HTTP Header field “X-Forwarded-For” (documented below). Available in v1.13.0+.

Supporting Types

ListenerXForwardedFor

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RetriveClientIp bool
RetriveSlbId bool

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

RetriveSlbIp bool

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

RetriveSlbProto bool

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

RetriveClientIp bool
RetriveSlbId bool

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

RetriveSlbIp bool

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

RetriveSlbProto bool

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

retriveClientIp boolean
retriveSlbId boolean

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

retriveSlbIp boolean

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

retriveSlbProto boolean

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

retriveClientIp bool
retriveSlbId bool

Whether to use the XForwardedFor header to obtain the ID of the SLB instance. Default to false.

retriveSlbIp bool

Whether to use the XForwardedFor_SLBIP header to obtain the public IP address of the SLB instance. Default to false.

retriveSlbProto bool

Whether to use the XForwardedFor_proto header to obtain the protocol used by the listener. Default to false.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.