1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. slb
  5. getListeners
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.slb.getListeners

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

This data source provides the listeners related to a server load balancer of the current Alibaba Cloud user.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const _default = new alicloud.slb.ApplicationLoadBalancer("default", {loadBalancerName: "tf-testAccSlbListenertcp"});
const tcp = new alicloud.slb.Listener("tcp", {
    loadBalancerId: _default.id,
    backendPort: 22,
    frontendPort: 22,
    protocol: "tcp",
    bandwidth: 10,
    healthCheckType: "tcp",
    persistenceTimeout: 3600,
    healthyThreshold: 8,
    unhealthyThreshold: 8,
    healthCheckTimeout: 8,
    healthCheckInterval: 5,
    healthCheckHttpCode: "http_2xx",
    healthCheckConnectPort: 20,
    healthCheckUri: "/console",
    establishedTimeout: 600,
});
const sampleDs = alicloud.slb.getListenersOutput({
    loadBalancerId: _default.id,
});
export const firstSlbListenerProtocol = sampleDs.apply(sampleDs => sampleDs.slbListeners?.[0]?.protocol);
Copy
import pulumi
import pulumi_alicloud as alicloud

default = alicloud.slb.ApplicationLoadBalancer("default", load_balancer_name="tf-testAccSlbListenertcp")
tcp = alicloud.slb.Listener("tcp",
    load_balancer_id=default.id,
    backend_port=22,
    frontend_port=22,
    protocol="tcp",
    bandwidth=10,
    health_check_type="tcp",
    persistence_timeout=3600,
    healthy_threshold=8,
    unhealthy_threshold=8,
    health_check_timeout=8,
    health_check_interval=5,
    health_check_http_code="http_2xx",
    health_check_connect_port=20,
    health_check_uri="/console",
    established_timeout=600)
sample_ds = alicloud.slb.get_listeners_output(load_balancer_id=default.id)
pulumi.export("firstSlbListenerProtocol", sample_ds.slb_listeners[0].protocol)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/slb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := slb.NewApplicationLoadBalancer(ctx, "default", &slb.ApplicationLoadBalancerArgs{
			LoadBalancerName: pulumi.String("tf-testAccSlbListenertcp"),
		})
		if err != nil {
			return err
		}
		_, err = slb.NewListener(ctx, "tcp", &slb.ListenerArgs{
			LoadBalancerId:         _default.ID(),
			BackendPort:            pulumi.Int(22),
			FrontendPort:           pulumi.Int(22),
			Protocol:               pulumi.String("tcp"),
			Bandwidth:              pulumi.Int(10),
			HealthCheckType:        pulumi.String("tcp"),
			PersistenceTimeout:     pulumi.Int(3600),
			HealthyThreshold:       pulumi.Int(8),
			UnhealthyThreshold:     pulumi.Int(8),
			HealthCheckTimeout:     pulumi.Int(8),
			HealthCheckInterval:    pulumi.Int(5),
			HealthCheckHttpCode:    pulumi.String("http_2xx"),
			HealthCheckConnectPort: pulumi.Int(20),
			HealthCheckUri:         pulumi.String("/console"),
			EstablishedTimeout:     pulumi.Int(600),
		})
		if err != nil {
			return err
		}
		sampleDs := slb.GetListenersOutput(ctx, slb.GetListenersOutputArgs{
			LoadBalancerId: _default.ID(),
		}, nil)
		ctx.Export("firstSlbListenerProtocol", sampleDs.ApplyT(func(sampleDs slb.GetListenersResult) (*string, error) {
			return &sampleDs.SlbListeners[0].Protocol, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = new AliCloud.Slb.ApplicationLoadBalancer("default", new()
    {
        LoadBalancerName = "tf-testAccSlbListenertcp",
    });

    var tcp = new AliCloud.Slb.Listener("tcp", new()
    {
        LoadBalancerId = @default.Id,
        BackendPort = 22,
        FrontendPort = 22,
        Protocol = "tcp",
        Bandwidth = 10,
        HealthCheckType = "tcp",
        PersistenceTimeout = 3600,
        HealthyThreshold = 8,
        UnhealthyThreshold = 8,
        HealthCheckTimeout = 8,
        HealthCheckInterval = 5,
        HealthCheckHttpCode = "http_2xx",
        HealthCheckConnectPort = 20,
        HealthCheckUri = "/console",
        EstablishedTimeout = 600,
    });

    var sampleDs = AliCloud.Slb.GetListeners.Invoke(new()
    {
        LoadBalancerId = @default.Id,
    });

    return new Dictionary<string, object?>
    {
        ["firstSlbListenerProtocol"] = sampleDs.Apply(getListenersResult => getListenersResult.SlbListeners[0]?.Protocol),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.slb.ApplicationLoadBalancer;
import com.pulumi.alicloud.slb.ApplicationLoadBalancerArgs;
import com.pulumi.alicloud.slb.Listener;
import com.pulumi.alicloud.slb.ListenerArgs;
import com.pulumi.alicloud.slb.SlbFunctions;
import com.pulumi.alicloud.slb.inputs.GetListenersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ApplicationLoadBalancer("default", ApplicationLoadBalancerArgs.builder()
            .loadBalancerName("tf-testAccSlbListenertcp")
            .build());

        var tcp = new Listener("tcp", ListenerArgs.builder()
            .loadBalancerId(default_.id())
            .backendPort("22")
            .frontendPort("22")
            .protocol("tcp")
            .bandwidth("10")
            .healthCheckType("tcp")
            .persistenceTimeout(3600)
            .healthyThreshold(8)
            .unhealthyThreshold(8)
            .healthCheckTimeout(8)
            .healthCheckInterval(5)
            .healthCheckHttpCode("http_2xx")
            .healthCheckConnectPort(20)
            .healthCheckUri("/console")
            .establishedTimeout(600)
            .build());

        final var sampleDs = SlbFunctions.getListeners(GetListenersArgs.builder()
            .loadBalancerId(default_.id())
            .build());

        ctx.export("firstSlbListenerProtocol", sampleDs.applyValue(getListenersResult -> getListenersResult).applyValue(sampleDs -> sampleDs.applyValue(getListenersResult -> getListenersResult.slbListeners()[0].protocol())));
    }
}
Copy
resources:
  default:
    type: alicloud:slb:ApplicationLoadBalancer
    properties:
      loadBalancerName: tf-testAccSlbListenertcp
  tcp:
    type: alicloud:slb:Listener
    properties:
      loadBalancerId: ${default.id}
      backendPort: '22'
      frontendPort: '22'
      protocol: tcp
      bandwidth: '10'
      healthCheckType: tcp
      persistenceTimeout: 3600
      healthyThreshold: 8
      unhealthyThreshold: 8
      healthCheckTimeout: 8
      healthCheckInterval: 5
      healthCheckHttpCode: http_2xx
      healthCheckConnectPort: 20
      healthCheckUri: /console
      establishedTimeout: 600
variables:
  sampleDs:
    fn::invoke:
      function: alicloud:slb:getListeners
      arguments:
        loadBalancerId: ${default.id}
outputs:
  firstSlbListenerProtocol: ${sampleDs.slbListeners[0].protocol}
Copy

Using getListeners

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getListeners(args: GetListenersArgs, opts?: InvokeOptions): Promise<GetListenersResult>
function getListenersOutput(args: GetListenersOutputArgs, opts?: InvokeOptions): Output<GetListenersResult>
Copy
def get_listeners(description_regex: Optional[str] = None,
                  frontend_port: Optional[int] = None,
                  load_balancer_id: Optional[str] = None,
                  output_file: Optional[str] = None,
                  protocol: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListenersResult
def get_listeners_output(description_regex: Optional[pulumi.Input[str]] = None,
                  frontend_port: Optional[pulumi.Input[int]] = None,
                  load_balancer_id: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  protocol: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListenersResult]
Copy
func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)
func GetListenersOutput(ctx *Context, args *GetListenersOutputArgs, opts ...InvokeOption) GetListenersResultOutput
Copy

> Note: This function is named GetListeners in the Go SDK.

public static class GetListeners 
{
    public static Task<GetListenersResult> InvokeAsync(GetListenersArgs args, InvokeOptions? opts = null)
    public static Output<GetListenersResult> Invoke(GetListenersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
public static Output<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:slb/getListeners:getListeners
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LoadBalancerId This property is required. string
ID of the SLB with listeners.
DescriptionRegex Changes to this property will trigger replacement. string
A regex string to filter results by SLB listener description.
FrontendPort Changes to this property will trigger replacement. int
Filter listeners by the specified frontend port.
OutputFile string
File name where to save data source results (after running pulumi preview).
Protocol Changes to this property will trigger replacement. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
LoadBalancerId This property is required. string
ID of the SLB with listeners.
DescriptionRegex Changes to this property will trigger replacement. string
A regex string to filter results by SLB listener description.
FrontendPort Changes to this property will trigger replacement. int
Filter listeners by the specified frontend port.
OutputFile string
File name where to save data source results (after running pulumi preview).
Protocol Changes to this property will trigger replacement. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
loadBalancerId This property is required. String
ID of the SLB with listeners.
descriptionRegex Changes to this property will trigger replacement. String
A regex string to filter results by SLB listener description.
frontendPort Changes to this property will trigger replacement. Integer
Filter listeners by the specified frontend port.
outputFile String
File name where to save data source results (after running pulumi preview).
protocol Changes to this property will trigger replacement. String
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
loadBalancerId This property is required. string
ID of the SLB with listeners.
descriptionRegex Changes to this property will trigger replacement. string
A regex string to filter results by SLB listener description.
frontendPort Changes to this property will trigger replacement. number
Filter listeners by the specified frontend port.
outputFile string
File name where to save data source results (after running pulumi preview).
protocol Changes to this property will trigger replacement. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
load_balancer_id This property is required. str
ID of the SLB with listeners.
description_regex Changes to this property will trigger replacement. str
A regex string to filter results by SLB listener description.
frontend_port Changes to this property will trigger replacement. int
Filter listeners by the specified frontend port.
output_file str
File name where to save data source results (after running pulumi preview).
protocol Changes to this property will trigger replacement. str
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
loadBalancerId This property is required. String
ID of the SLB with listeners.
descriptionRegex Changes to this property will trigger replacement. String
A regex string to filter results by SLB listener description.
frontendPort Changes to this property will trigger replacement. Number
Filter listeners by the specified frontend port.
outputFile String
File name where to save data source results (after running pulumi preview).
protocol Changes to this property will trigger replacement. String
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

getListeners Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerId string
SlbListeners List<Pulumi.AliCloud.Slb.Outputs.GetListenersSlbListener>
A list of SLB listeners. Each element contains the following attributes:
DescriptionRegex string
FrontendPort int
Frontend port used to receive incoming traffic and distribute it to the backend servers.
OutputFile string
Protocol string
Listener protocol. Possible values: http, https, tcp and udp.
Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerId string
SlbListeners []GetListenersSlbListener
A list of SLB listeners. Each element contains the following attributes:
DescriptionRegex string
FrontendPort int
Frontend port used to receive incoming traffic and distribute it to the backend servers.
OutputFile string
Protocol string
Listener protocol. Possible values: http, https, tcp and udp.
id String
The provider-assigned unique ID for this managed resource.
loadBalancerId String
slbListeners List<GetListenersSlbListener>
A list of SLB listeners. Each element contains the following attributes:
descriptionRegex String
frontendPort Integer
Frontend port used to receive incoming traffic and distribute it to the backend servers.
outputFile String
protocol String
Listener protocol. Possible values: http, https, tcp and udp.
id string
The provider-assigned unique ID for this managed resource.
loadBalancerId string
slbListeners GetListenersSlbListener[]
A list of SLB listeners. Each element contains the following attributes:
descriptionRegex string
frontendPort number
Frontend port used to receive incoming traffic and distribute it to the backend servers.
outputFile string
protocol string
Listener protocol. Possible values: http, https, tcp and udp.
id str
The provider-assigned unique ID for this managed resource.
load_balancer_id str
slb_listeners Sequence[GetListenersSlbListener]
A list of SLB listeners. Each element contains the following attributes:
description_regex str
frontend_port int
Frontend port used to receive incoming traffic and distribute it to the backend servers.
output_file str
protocol str
Listener protocol. Possible values: http, https, tcp and udp.
id String
The provider-assigned unique ID for this managed resource.
loadBalancerId String
slbListeners List<Property Map>
A list of SLB listeners. Each element contains the following attributes:
descriptionRegex String
frontendPort Number
Frontend port used to receive incoming traffic and distribute it to the backend servers.
outputFile String
protocol String
Listener protocol. Possible values: http, https, tcp and udp.

Supporting Types

GetListenersSlbListener

BackendPort This property is required. int
Port opened on the backend server to receive requests.
Bandwidth This property is required. int
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId This property is required. string
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie This property is required. string
Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout This property is required. int
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description This property is required. string
The description of slb listener.
EnableHttp2 This property is required. string
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout This property is required. int
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort This property is required. int
Filter listeners by the specified frontend port.
Gzip This property is required. string
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
HealthCheck This property is required. string
Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort This property is required. int
Port used for health check.
HealthCheckConnectTimeout This property is required. int
Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain This property is required. string
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthCheckHttpCode This property is required. string
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthCheckInterval This property is required. int
Time interval between two consecutive health checks.
HealthCheckTimeout This property is required. int
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
HealthCheckType This property is required. string
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri This property is required. string
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthyThreshold This property is required. int
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout This property is required. int
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId This property is required. string
ID of the active/standby server group.
PersistenceTimeout This property is required. int
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
Protocol This property is required. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
ProxyProtocolV2Enabled This property is required. bool
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.
RequestTimeout This property is required. 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 This property is required. string
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus This property is required. string
Security status. Only available when the protocol is https.
ServerCertificateId This property is required. string
ServerGroupId This property is required. string
ID of the linked VServer group.
SslCertificateId This property is required. string
ID of the server certificate. Only available when the protocol is https.
Status This property is required. string
Listener status.
StickySession This property is required. string
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
StickySessionType This property is required. string
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
TlsCipherPolicy This property is required. 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.
UnhealthyThreshold This property is required. int
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbId This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbIp This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbProto This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.
BackendPort This property is required. int
Port opened on the backend server to receive requests.
Bandwidth This property is required. int
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId This property is required. string
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie This property is required. string
Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout This property is required. int
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description This property is required. string
The description of slb listener.
EnableHttp2 This property is required. string
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout This property is required. int
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort This property is required. int
Filter listeners by the specified frontend port.
Gzip This property is required. string
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
HealthCheck This property is required. string
Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort This property is required. int
Port used for health check.
HealthCheckConnectTimeout This property is required. int
Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain This property is required. string
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthCheckHttpCode This property is required. string
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthCheckInterval This property is required. int
Time interval between two consecutive health checks.
HealthCheckTimeout This property is required. int
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
HealthCheckType This property is required. string
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri This property is required. string
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthyThreshold This property is required. int
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout This property is required. int
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId This property is required. string
ID of the active/standby server group.
PersistenceTimeout This property is required. int
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
Protocol This property is required. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
ProxyProtocolV2Enabled This property is required. bool
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.
RequestTimeout This property is required. 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 This property is required. string
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus This property is required. string
Security status. Only available when the protocol is https.
ServerCertificateId This property is required. string
ServerGroupId This property is required. string
ID of the linked VServer group.
SslCertificateId This property is required. string
ID of the server certificate. Only available when the protocol is https.
Status This property is required. string
Listener status.
StickySession This property is required. string
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
StickySessionType This property is required. string
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
TlsCipherPolicy This property is required. 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.
UnhealthyThreshold This property is required. int
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbId This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbIp This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
XForwardedForSlbProto This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.
backendPort This property is required. Integer
Port opened on the backend server to receive requests.
bandwidth This property is required. Integer
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId This property is required. String
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie This property is required. String
Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout This property is required. Integer
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description This property is required. String
The description of slb listener.
enableHttp2 This property is required. String
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout This property is required. Integer
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort This property is required. Integer
Filter listeners by the specified frontend port.
gzip This property is required. String
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
healthCheck This property is required. String
Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort This property is required. Integer
Port used for health check.
healthCheckConnectTimeout This property is required. Integer
Amount of time in seconds to wait for the response for a health check.
healthCheckDomain This property is required. String
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckHttpCode This property is required. String
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckInterval This property is required. Integer
Time interval between two consecutive health checks.
healthCheckTimeout This property is required. Integer
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
healthCheckType This property is required. String
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri This property is required. String
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthyThreshold This property is required. Integer
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout This property is required. Integer
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId This property is required. String
ID of the active/standby server group.
persistenceTimeout This property is required. Integer
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
protocol This property is required. String
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled This property is required. Boolean
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.
requestTimeout This property is required. Integer
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 This property is required. String
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus This property is required. String
Security status. Only available when the protocol is https.
serverCertificateId This property is required. String
serverGroupId This property is required. String
ID of the linked VServer group.
sslCertificateId This property is required. String
ID of the server certificate. Only available when the protocol is https.
status This property is required. String
Listener status.
stickySession This property is required. String
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
stickySessionType This property is required. String
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
tlsCipherPolicy This property is required. 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.
unhealthyThreshold This property is required. Integer
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbId This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbIp This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbProto This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.
backendPort This property is required. number
Port opened on the backend server to receive requests.
bandwidth This property is required. number
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId This property is required. string
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie This property is required. string
Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout This property is required. number
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description This property is required. string
The description of slb listener.
enableHttp2 This property is required. string
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout This property is required. number
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort This property is required. number
Filter listeners by the specified frontend port.
gzip This property is required. string
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
healthCheck This property is required. string
Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort This property is required. number
Port used for health check.
healthCheckConnectTimeout This property is required. number
Amount of time in seconds to wait for the response for a health check.
healthCheckDomain This property is required. string
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckHttpCode This property is required. string
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckInterval This property is required. number
Time interval between two consecutive health checks.
healthCheckTimeout This property is required. number
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
healthCheckType This property is required. string
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri This property is required. string
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthyThreshold This property is required. number
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout This property is required. number
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId This property is required. string
ID of the active/standby server group.
persistenceTimeout This property is required. number
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
protocol This property is required. string
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled This property is required. boolean
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.
requestTimeout This property is required. 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 This property is required. string
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus This property is required. string
Security status. Only available when the protocol is https.
serverCertificateId This property is required. string
serverGroupId This property is required. string
ID of the linked VServer group.
sslCertificateId This property is required. string
ID of the server certificate. Only available when the protocol is https.
status This property is required. string
Listener status.
stickySession This property is required. string
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
stickySessionType This property is required. string
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
tlsCipherPolicy This property is required. 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.
unhealthyThreshold This property is required. number
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbId This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbIp This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbProto This property is required. string
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.
backend_port This property is required. int
Port opened on the backend server to receive requests.
bandwidth This property is required. int
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
ca_certificate_id This property is required. str
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie This property is required. str
Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookie_timeout This property is required. int
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description This property is required. str
The description of slb listener.
enable_http2 This property is required. str
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
established_timeout This property is required. int
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontend_port This property is required. int
Filter listeners by the specified frontend port.
gzip This property is required. str
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
health_check This property is required. str
Indicate whether health check is enabled of not. Possible values are on and off.
health_check_connect_port This property is required. int
Port used for health check.
health_check_connect_timeout This property is required. int
Amount of time in seconds to wait for the response for a health check.
health_check_domain This property is required. str
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
health_check_http_code This property is required. str
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
health_check_interval This property is required. int
Time interval between two consecutive health checks.
health_check_timeout This property is required. int
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
health_check_type This property is required. str
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
health_check_uri This property is required. str
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthy_threshold This property is required. int
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idle_timeout This property is required. int
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
master_slave_server_group_id This property is required. str
ID of the active/standby server group.
persistence_timeout This property is required. int
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
protocol This property is required. str
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxy_protocol_v2_enabled This property is required. bool
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.
request_timeout This property is required. 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 This property is required. str
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
security_status This property is required. str
Security status. Only available when the protocol is https.
server_certificate_id This property is required. str
server_group_id This property is required. str
ID of the linked VServer group.
ssl_certificate_id This property is required. str
ID of the server certificate. Only available when the protocol is https.
status This property is required. str
Listener status.
sticky_session This property is required. str
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
sticky_session_type This property is required. str
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
tls_cipher_policy This property is required. 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.
unhealthy_threshold This property is required. int
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
x_forwarded_for This property is required. str
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
x_forwarded_for_slb_id This property is required. str
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
x_forwarded_for_slb_ip This property is required. str
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
x_forwarded_for_slb_proto This property is required. str
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.
backendPort This property is required. Number
Port opened on the backend server to receive requests.
bandwidth This property is required. Number
Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId This property is required. String
ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie This property is required. String
Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout This property is required. Number
Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description This property is required. String
The description of slb listener.
enableHttp2 This property is required. String
Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout This property is required. Number
Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort This property is required. Number
Filter listeners by the specified frontend port.
gzip This property is required. String
Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
healthCheck This property is required. String
Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort This property is required. Number
Port used for health check.
healthCheckConnectTimeout This property is required. Number
Amount of time in seconds to wait for the response for a health check.
healthCheckDomain This property is required. String
Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckHttpCode This property is required. String
HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthCheckInterval This property is required. Number
Time interval between two consecutive health checks.
healthCheckTimeout This property is required. Number
Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.
healthCheckType This property is required. String
Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri This property is required. String
URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthyThreshold This property is required. Number
Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout This property is required. Number
Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId This property is required. String
ID of the active/standby server group.
persistenceTimeout This property is required. Number
Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.
protocol This property is required. String
Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled This property is required. Boolean
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.
requestTimeout This property is required. 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 This property is required. String
Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus This property is required. String
Security status. Only available when the protocol is https.
serverCertificateId This property is required. String
serverGroupId This property is required. String
ID of the linked VServer group.
sslCertificateId This property is required. String
ID of the server certificate. Only available when the protocol is https.
status This property is required. String
Listener status.
stickySession This property is required. String
Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.
stickySessionType This property is required. String
Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.
tlsCipherPolicy This property is required. 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.
unhealthyThreshold This property is required. Number
Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbId This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbIp This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.
xForwardedForSlbProto This property is required. String
Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi