Class ListenerArgs

Inheritance

System.Object

InputArgs

ResourceArgs

ListenerArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.Slb

Assembly: Pulumi.AliCloud.dll

Syntax

public sealed class ListenerArgs : ResourceArgs

Constructors

ListenerArgs()

Declaration

public ListenerArgs()

Properties

AclId

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

Declaration

public Input<string> AclId { get; set; }

Property Value

Type	Description
Input<System.String>

AclStatus

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

Declaration

public Input<string> AclStatus { get; set; }

Property Value

Type	Description
Input<System.String>

AclType

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

Declaration

public Input<string> AclType { get; set; }

Property Value

Type	Description
Input<System.String>

BackendPort

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

Declaration

public Input<int> BackendPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

Bandwidth

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

Declaration

public Input<int> Bandwidth { get; set; }

Property Value

Type	Description
Input<System.Int32>

Cookie

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

Declaration

public Input<string> Cookie { get; set; }

Property Value

Type	Description
Input<System.String>

CookieTimeout

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

Declaration

public Input<int> CookieTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

DeleteProtectionValidation

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

Declaration

public Input<bool> DeleteProtectionValidation { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Description

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

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

EnableHttp2

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

Declaration

public Input<string> EnableHttp2 { get; set; }

Property Value

Type	Description
Input<System.String>

EstablishedTimeout

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

Declaration

public Input<int> EstablishedTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

ForwardPort

The port that http redirect to https.

Declaration

public Input<int> ForwardPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

FrontendPort

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

Declaration

public Input<int> FrontendPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

Gzip

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

Declaration

public Input<bool> Gzip { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HealthCheck

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

Declaration

public Input<string> HealthCheck { get; set; }

Property Value

Type	Description
Input<System.String>

HealthCheckConnectPort

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

Declaration

public Input<int> HealthCheckConnectPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

HealthCheckDomain

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

Declaration

public Input<string> HealthCheckDomain { get; set; }

Property Value

Type	Description
Input<System.String>

HealthCheckHttpCode

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

Declaration

public Input<string> HealthCheckHttpCode { get; set; }

Property Value

Type	Description
Input<System.String>

HealthCheckInterval

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

Declaration

public Input<int> HealthCheckInterval { get; set; }

Property Value

Type	Description
Input<System.Int32>

HealthCheckMethod

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

Declaration

public Input<string> HealthCheckMethod { get; set; }

Property Value

Type	Description
Input<System.String>

HealthCheckTimeout

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

Declaration

public Input<int> HealthCheckTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

HealthCheckType

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

Declaration

public Input<string> HealthCheckType { get; set; }

Property Value

Type	Description
Input<System.String>

HealthCheckUri

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

Declaration

public Input<string> HealthCheckUri { get; set; }

Property Value

Type	Description
Input<System.String>

HealthyThreshold

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

Declaration

public Input<int> HealthyThreshold { get; set; }

Property Value

Type	Description
Input<System.Int32>

IdleTimeout

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

Declaration

public Input<int> IdleTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

InstancePort

Declaration

public Input<int> InstancePort { get; set; }

Property Value

Type	Description
Input<System.Int32>

LbPort

Declaration

public Input<int> LbPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

LbProtocol

Declaration

public Input<string> LbProtocol { get; set; }

Property Value

Type	Description
Input<System.String>

ListenerForward

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

Declaration

public Input<string> ListenerForward { get; set; }

Property Value

Type	Description
Input<System.String>

LoadBalancerId

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

Declaration

public Input<string> LoadBalancerId { get; set; }

Property Value

Type	Description
Input<System.String>

MasterSlaveServerGroupId

Declaration

public Input<string> MasterSlaveServerGroupId { get; set; }

Property Value

Type	Description
Input<System.String>

PersistenceTimeout

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

Declaration

public Input<int> PersistenceTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

Protocol

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

Declaration

public Input<string> Protocol { get; set; }

Property Value

Type	Description
Input<System.String>

RequestTimeout

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.

Declaration

public Input<int> RequestTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

Scheduler

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

Declaration

public Input<string> Scheduler { get; set; }

Property Value

Type	Description
Input<System.String>

ServerCertificateId

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

Declaration

public Input<string> ServerCertificateId { get; set; }

Property Value

Type	Description
Input<System.String>

ServerGroupId

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

Declaration

public Input<string> ServerGroupId { get; set; }

Property Value

Type	Description
Input<System.String>

SslCertificateId

It has been deprecated from 1.59.0 and using server_certificate_id instead.

Declaration

public Input<string> SslCertificateId { get; set; }

Property Value

Type	Description
Input<System.String>

StickySession

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

Declaration

public Input<string> StickySession { get; set; }

Property Value

Type	Description
Input<System.String>

StickySessionType

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

Declaration

public Input<string> StickySessionType { get; set; }

Property Value

Type	Description
Input<System.String>

TlsCipherPolicy

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

Declaration

public Input<string> TlsCipherPolicy { get; set; }

Property Value

Type	Description
Input<System.String>

UnhealthyThreshold

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

Declaration

public Input<int> UnhealthyThreshold { get; set; }

Property Value

Type	Description
Input<System.Int32>

XForwardedFor

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

Declaration

public Input<ListenerXForwardedForArgs> XForwardedFor { get; set; }

Property Value

Type	Description
Input<ListenerXForwardedForArgs>