Updated on 2022-02-22 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

Mandatory

Descripiton

protocol

Yes

Listening protocol

Type: string

Value Description: This value can be TCP or HTTP.

Value Constraint: This value can be TCP or HTTP.

Suggestion: Set the value based on the live environment.

description

No

Description

Type: string

Value Description: Customize the value.

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: The value ranges from -1 to 2147483647.

Suggestion: Set the value based on the live environment.

loadBalancerId

Yes

ID of the belonged ULB

Type: string

Value Description: 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, obtain the ULB instance ID on the ULB console and enter it accordingly.

port

Yes

Listening port

Type: integer

Value Description: The value ranges from 1 to 65535.

Value Constraint: The value ranges from 1 to 65535.

Suggestion: Set the value based on the live environment.

name

No

Listener name

Type: string

Value Description: Customize the value.

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

Inclusion

ULB.LoadBalancer

Return Value

Property

Type

Description

refName

string

Listener instance name

refID

string

Listener instance ID

Blueprint Example

tosca_definitions_version: cloud_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: Cloud.ULB.Listener
    properties:
      protocol:
        get_input: listener_protocol
      port:
        get_input: listener_port
      loadBalancerId:
        get_input: listener_loadBalancerId