Updated on 2023-12-13 GMT+08:00

ULB.Listener

Element Description

The ULB.Listener element indicates the listener under a shared load balancer. One shared load balancer corresponds to multiple listeners. You can add or delete listeners as required.

Element Properties

Table 1 Property Description

Property

Required

Descripiton

protocol

Yes

Listening protocol

Type: string

Value Description: This value can be TCP or HTTP.

Value Constraint: Supports"TCP", "HTTP"

Suggestion: Set the value based on specifications and requirements.

description

No

Description

Type: string

Value Description: Supports customization.

Value Constraint: The value supports a maximum of 255 characters.

Suggestion: Customize the value.

connectionLimit

No

Maximum number of connections of the listener

Type: integer

Value Description: If the number of connections is -1, there is no constraints.

Value Constraint: Supports [-1, 2147483647]

Suggestion: Set the value based on specifications and requirements.

loadBalancerId

Yes

ID of the belonged ULB

Type: string

Value Description: Indicates the ID generated after a ULB instance is created, for example, 8abbd7a9-c1f8-440d-96ff-376ee7382082.

Value Constraint: The ID must be the ID of an existing ULB instance.

Suggestion: You are advised to drag the object to the ULB.LoadBalancer and use the get_reference function to automatically generate the value. Alternatively, query the ULB instance ID on the ULB page and enter it accordingly.

port

Yes

Listening port

Type: integer

Value Description: [1, 65535]

Value Constraint: Supports [1, 65535]

Suggestion: Set the value based on specifications and requirements.

name

No

Listener name

Type: string

Value Description: Supports customization.

Value Constraint: The value supports a maximum of 64 characters and can only contain digits, letters, underscores (_), and hyphens (-).

Suggestion: Customize the value.

Relationships Between Elements

Table 2 Relationship description

Description

Target

ContainedIn

ULB.LoadBalancer

Return Value

Property

Type

Description

refName

string

Listener instance name

refID

string

Listener instance ID

Blueprint Example

tosca_definitions_version: huaweicloud_tosca_version_1_0 
 inputs: 
   listener_protocol: 
     description: Listening protocol 
     label: '' 
   listener_port: 
     description: Listening port 
     label: '' 
   listener_loadBalancerId: 
     description: ID of the belonged ULB 
     label: '' 
 node_templates: 
   listener: 
     type: HuaweiCloud.ULB.Listener 
     properties: 
       protocol: 
         get_input: listener_protocol 
       port: 
         get_input: listener_port 
       loadBalancerId: 
         get_input: listener_loadBalancerId