Alibaba Cloud v3.62.1, Sep 16 24

Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

alicloud.slb.getListeners

Explore with Pulumi AI

Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

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);

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)

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 {
		_, 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
	})
}

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),
    };
});

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())));
    }
}

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}

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>

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]

func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)
func GetListenersOutput(ctx *Context, args *GetListenersOutputArgs, opts ...InvokeOption) GetListenersResultOutput

> 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)
}

public static CompletableFuture<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:slb/getListeners:getListeners
  arguments:
    # arguments dictionary

The following arguments are supported:

LoadBalancerId string: ID of the SLB with listeners.
DescriptionRegex string: A regex string to filter results by SLB listener description.
FrontendPort int: Filter listeners by the specified frontend port.
OutputFile string: File name where to save data source results (after running pulumi preview).
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

LoadBalancerId string: ID of the SLB with listeners.
DescriptionRegex string: A regex string to filter results by SLB listener description.
FrontendPort int: Filter listeners by the specified frontend port.
OutputFile string: File name where to save data source results (after running pulumi preview).
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

loadBalancerId String: ID of the SLB with listeners.
descriptionRegex String: A regex string to filter results by SLB listener description.
frontendPort Integer: Filter listeners by the specified frontend port.
outputFile String: File name where to save data source results (after running pulumi preview).
protocol String: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

loadBalancerId string: ID of the SLB with listeners.
descriptionRegex string: A regex string to filter results by SLB listener description.
frontendPort number: Filter listeners by the specified frontend port.
outputFile string: File name where to save data source results (after running pulumi preview).
protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

load_balancer_id str: ID of the SLB with listeners.
description_regex str: A regex string to filter results by SLB listener description.
frontend_port int: Filter listeners by the specified frontend port.
output_file str: File name where to save data source results (after running pulumi preview).
protocol str: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

loadBalancerId String: ID of the SLB with listeners.
descriptionRegex String: A regex string to filter results by SLB listener description.
frontendPort Number: Filter listeners by the specified frontend port.
outputFile String: File name where to save data source results (after running pulumi preview).
protocol 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 int: Port opened on the backend server to receive requests.
Bandwidth int: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout int: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description string: The description of slb listener.
EnableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout int: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort int: Filter listeners by the specified frontend port.
Gzip 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 string: Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort int: Port used for health check.
HealthCheckConnectTimeout int: Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain 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 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 int: Time interval between two consecutive health checks.
HealthCheckTimeout 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 string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri 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 int: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout int: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId string: ID of the active/standby server group.
PersistenceTimeout 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 string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
ProxyProtocolV2Enabled 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 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: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus string: Security status. Only available when the protocol is https.
ServerCertificateId string
ServerGroupId string: ID of the linked VServer group.
SslCertificateId string: ID of the server certificate. Only available when the protocol is https.
Status string: Listener status.
StickySession 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 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 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 int: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor 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 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 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 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 int: Port opened on the backend server to receive requests.
Bandwidth int: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout int: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description string: The description of slb listener.
EnableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout int: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort int: Filter listeners by the specified frontend port.
Gzip 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 string: Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort int: Port used for health check.
HealthCheckConnectTimeout int: Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain 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 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 int: Time interval between two consecutive health checks.
HealthCheckTimeout 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 string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri 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 int: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout int: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId string: ID of the active/standby server group.
PersistenceTimeout 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 string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
ProxyProtocolV2Enabled 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 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: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus string: Security status. Only available when the protocol is https.
ServerCertificateId string
ServerGroupId string: ID of the linked VServer group.
SslCertificateId string: ID of the server certificate. Only available when the protocol is https.
Status string: Listener status.
StickySession 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 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 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 int: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor 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 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 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 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 Integer: Port opened on the backend server to receive requests.
bandwidth Integer: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId String: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie String: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout Integer: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description String: The description of slb listener.
enableHttp2 String: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout Integer: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort Integer: Filter listeners by the specified frontend port.
gzip 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 String: Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort Integer: Port used for health check.
healthCheckConnectTimeout Integer: Amount of time in seconds to wait for the response for a health check.
healthCheckDomain 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 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 Integer: Time interval between two consecutive health checks.
healthCheckTimeout 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 String: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri 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 Integer: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout Integer: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId String: ID of the active/standby server group.
persistenceTimeout 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 String: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled 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 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 String: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus String: Security status. Only available when the protocol is https.
serverCertificateId String
serverGroupId String: ID of the linked VServer group.
sslCertificateId String: ID of the server certificate. Only available when the protocol is https.
status String: Listener status.
stickySession 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 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 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 Integer: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor 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 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 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 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 number: Port opened on the backend server to receive requests.
bandwidth number: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout number: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description string: The description of slb listener.
enableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout number: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort number: Filter listeners by the specified frontend port.
gzip 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 string: Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort number: Port used for health check.
healthCheckConnectTimeout number: Amount of time in seconds to wait for the response for a health check.
healthCheckDomain 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 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 number: Time interval between two consecutive health checks.
healthCheckTimeout 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 string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri 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 number: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout number: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId string: ID of the active/standby server group.
persistenceTimeout 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 string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled 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 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: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus string: Security status. Only available when the protocol is https.
serverCertificateId string
serverGroupId string: ID of the linked VServer group.
sslCertificateId string: ID of the server certificate. Only available when the protocol is https.
status string: Listener status.
stickySession 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 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 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 number: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor 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 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 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 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 int: Port opened on the backend server to receive requests.
bandwidth int: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
ca_certificate_id str: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie str: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookie_timeout int: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description str: The description of slb listener.
enable_http2 str: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
established_timeout int: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontend_port int: Filter listeners by the specified frontend port.
gzip 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 str: Indicate whether health check is enabled of not. Possible values are on and off.
health_check_connect_port int: Port used for health check.
health_check_connect_timeout int: Amount of time in seconds to wait for the response for a health check.
health_check_domain 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 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 int: Time interval between two consecutive health checks.
health_check_timeout 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 str: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
health_check_uri 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 int: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idle_timeout 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 str: ID of the active/standby server group.
persistence_timeout 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 str: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxy_protocol_v2_enabled 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 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 str: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
security_status str: Security status. Only available when the protocol is https.
server_certificate_id str
server_group_id str: ID of the linked VServer group.
ssl_certificate_id str: ID of the server certificate. Only available when the protocol is https.
status str: Listener status.
sticky_session 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 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 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 int: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
x_forwarded_for 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 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 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 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 Number: Port opened on the backend server to receive requests.
bandwidth Number: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId String: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie String: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout Number: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description String: The description of slb listener.
enableHttp2 String: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout Number: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort Number: Filter listeners by the specified frontend port.
gzip 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 String: Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort Number: Port used for health check.
healthCheckConnectTimeout Number: Amount of time in seconds to wait for the response for a health check.
healthCheckDomain 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 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 Number: Time interval between two consecutive health checks.
healthCheckTimeout 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 String: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri 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 Number: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout Number: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId String: ID of the active/standby server group.
persistenceTimeout 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 String: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
proxyProtocolV2Enabled 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 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: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus String: Security status. Only available when the protocol is https.
serverCertificateId String
serverGroupId String: ID of the linked VServer group.
sslCertificateId String: ID of the server certificate. Only available when the protocol is https.
status String: Listener status.
stickySession 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 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 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 Number: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor 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 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 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 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.62.1 published on Monday, Sep 16, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.slb.getListeners

On this page

On this page

Example Usage

Using getListeners

getListeners Result

Supporting Types

GetListenersSlbListener

Package Details

On this page

On this page