ALIYUN::SLB::Listener

Syntax

{
  "Type": "ALIYUN::SLB::Listener",
  "Properties": {
    "MasterSlaveServerGroupId": String,
    "AclStatus": String,
    "Protocol": String,
    "AclId": String,
    "ServerCertificateId": String,
    "HealthCheck": Map,
    "RequestTimeout": Integer,
    "IdleTimeout": Integer,
    "ListenerPort": Integer,
    "HttpConfig": Map,
    "Bandwidth": Integer,
    "AclType": String,
    "BackendServerPort": Integer,
    "Scheduler": String,
    "LoadBalancerId": String,
    "CACertificateId": String,
    "Persistence": Map,
    "VServerGroupId": String,
    "Description": String,
    "PortRange": List
  }
}

Properties

HealthCheck syntax

"HealthCheck": {
  "Domain": String,
  "Interval": Integer,
  "URI": String,
  "HttpCode": String,
  "HealthyThreshold": Integer,
  "HealthCheckType": String,
  "Timeout": Integer,
  "UnhealthyThreshold": Integer,
  "Port": Integer,
  "Switch": String
}

HealthCheck properties

Persistence syntax

"Persistence": {
  "PersistenceTimeout": Integer,
  "CookieTimeout": Integer,
  "XForwardedFor": String,
  "XForwardedFor_SLBID": String,
  "XForwardedFor_proto": String,
  "XForwardedFor_SLBIP": String,
  "Cookie": String,
  "StickySession": String,
  "StickySessionType": String
}

Persistence properties

HttpConfig syntax

"HttpConfig": {
  "ForwardPort": Integer,
  "ListenerForward": String
}

HttpConfig properties

PortRange syntax

"PortRange": [
  {
    "StartPort": Integer,
    "EndPort": Integer
  }
]

PortRange properties

Response parameters

Fn::GetAtt

• LoadBalancerId: the unique ID of the SLB instance.
• ListenerPortsAndProtocol: the ports and protocols used by the SLB listener.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RequestTimeout": {
      "Type": "Number",
      "Description": "Specify the request timeout in seconds. Valid value: 1-180 If no response is received from the backend server during the specified timeout period, Server Load Balancer will stop waiting and send an HTTP 504 error to the client.",
      "MinValue": 1,
      "MaxValue": 180
    },
    "ListenerPort": {
      "Type": "Number",
      "Description": "Port for front listener. Range from 0 to 65535.",
      "MinValue": 0,
      "MaxValue": 65535
    },
    "VServerGroupId": {
      "Type": "String",
      "Description": "The id of the VServerGroup which use in listener."
    },
    "Description": {
      "Type": "String",
      "Description": "The description of the listener.It must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_). Chinese characters are supported.",
      "MaxLength": 80
    },
    "CACertificateId": {
      "Type": "String",
      "Description": "CA server certificate id, for https listener only."
    },
    "Scheduler": {
      "Type": "String",
      "Description": "The scheduling algorithm. Valid values:\nwrr: Backend servers that have higher weights receive more requests than those that have lower weights.\nwlc: Requests are distributed based on the combination of the weights and connections to backend servers. If two backend servers have the same weight, the backend server that has fewer connections receives more requests.\nrr: Requests are distributed to backend servers in sequence.\nsch: specifies consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.\ntch: specifies consistent hashing that is based on four factors: source IP address, destination IP address, source port number, and destination port number. Requests that contain the same preceding information are distributed to the same backend server.\nDefault: wrr",
      "AllowedValues": [
        "wrr",
        "wlc",
        "rr",
        "sch",
        "tch"
      ],
      "Default": "wrr"
    },
    "AclId": {
      "Type": "String",
      "Description": "The ID of the access control list associated with the listener to be created.\nIf the value of the AclStatus parameter is on, this parameter is required."
    },
    "HealthCheck": {
      "Type": "Json",
      "Description": "The properties of health checking setting."
    },
    "IdleTimeout": {
      "Type": "Number",
      "Description": "Specify the idle connection timeout in seconds. Valid value: 1-60 If no request is received during the specified timeout period, Server Load Balancer will temporarily terminate the connection and restart the connection when the next request comes.",
      "MinValue": 1,
      "MaxValue": 60
    },
    "LoadBalancerId": {
      "Type": "String",
      "Description": "The id of load balancer to create listener."
    },
    "BackendServerPort": {
      "Type": "Number",
      "Description": "Backend server can listen on ports from 1 to 65535.",
      "MinValue": 1,
      "MaxValue": 65535
    },
    "Persistence": {
      "Type": "Json",
      "Description": "The properties of persistence."
    },
    "PortRange": {
      "Type": "Json",
      "Description": "Port range, only supports TCP or UDP listener. ListenerPort should be 0 when PortRange is specified.",
      "MinLength": 1,
      "MaxLength": 1
    },
    "AclStatus": {
      "Type": "String",
      "Description": "Indicates whether to enable access control.\nValid values: on | off. Default value: off",
      "AllowedValues": [
        "on",
        "off"
      ],
      "Default": "off"
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": "The bandwidth of network, unit in Mbps(Million bits per second). If the specified load balancer with \"LOAD_BALANCE_ID\" is charged by \"paybybandwidth\" and is created in classic network, each Listener's bandwidth must be greater than 0 and the sum of all of its Listeners' bandwidth can't be greater than the bandwidth of the load balancer.",
      "MinValue": -1,
      "MaxValue": 1000
    },
    "MasterSlaveServerGroupId": {
      "Type": "String",
      "Description": "The id of the MasterSlaveServerGroup which use in listener."
    },
    "ServerCertificateId": {
      "Type": "String",
      "Description": "Server certificate id, for https listener only, this properties is required."
    },
    "HttpConfig": {
      "Type": "Json",
      "Description": "Config for http protocol."
    },
    "AclType": {
      "Type": "String",
      "Description": "The access control type:\n* white: Indicates a whitelist. Only requests from IP addresses or CIDR blocks in the selected access control lists are forwarded. This applies to scenarios in which an application only allows access from specific IP addresses.\nEnabling a whitelist poses some risks to your services.\nAfter a whitelist is enabled, only the IP addresses in the list can access the listener.\nIf you enable a whitelist without adding any IP addresses in the list, no requests are forwarded.\n* black: Indicates a blacklist. Requests from IP addresses or CIDR blocks in the selected access control lists are not forwarded (that is, they are blocked). This applies to scenarios in which an application only denies access from specific IP addresses.\nIf you enable a blacklist without adding any IP addresses in the list, all requests are forwarded.\n\nIf the value of the AclStatus parameter is on, this parameter is required.",
      "AllowedValues": [
        "white",
        "black"
      ]
    },
    "Protocol": {
      "Type": "String",
      "Description": "The load balancer transport protocol to use for routing: http, https, tcp, or udp.",
      "AllowedValues": [
        "http",
        "https",
        "tcp",
        "udp"
      ]
    }
  },
  "Resources": {
    "Listener": {
      "Type": "ALIYUN::SLB::Listener",
      "Properties": {
        "RequestTimeout": {
          "Ref": "RequestTimeout"
        },
        "ListenerPort": {
          "Ref": "ListenerPort"
        },
        "VServerGroupId": {
          "Ref": "VServerGroupId"
        },
        "Description": {
          "Ref": "Description"
        },
        "CACertificateId": {
          "Ref": "CACertificateId"
        },
        "Scheduler": {
          "Ref": "Scheduler"
        },
        "AclId": {
          "Ref": "AclId"
        },
        "HealthCheck": {
          "Ref": "HealthCheck"
        },
        "IdleTimeout": {
          "Ref": "IdleTimeout"
        },
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        },
        "BackendServerPort": {
          "Ref": "BackendServerPort"
        },
        "Persistence": {
          "Ref": "Persistence"
        },
        "PortRange": {
          "Ref": "PortRange"
        },
        "AclStatus": {
          "Ref": "AclStatus"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "MasterSlaveServerGroupId": {
          "Ref": "MasterSlaveServerGroupId"
        },
        "ServerCertificateId": {
          "Ref": "ServerCertificateId"
        },
        "HttpConfig": {
          "Ref": "HttpConfig"
        },
        "AclType": {
          "Ref": "AclType"
        },
        "Protocol": {
          "Ref": "Protocol"
        }
      }
    }
  },
  "Outputs": {
    "ListenerPortsAndProtocol": {
      "Description": "The collection of listener.",
      "Value": {
        "Fn::GetAtt": [
          "Listener",
          "ListenerPortsAndProtocol"
        ]
      }
    },
    "LoadBalancerId": {
      "Description": "The id of load balancer",
      "Value": {
        "Fn::GetAtt": [
          "Listener",
          "LoadBalancerId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AclId:
    Description: 'The ID of the access control list associated with the listener to
      be created.

      If the value of the AclStatus parameter is on, this parameter is required.'
    Type: String
  AclStatus:
    AllowedValues:
    - 'on'
    - 'off'
    Default: 'off'
    Description: 'Indicates whether to enable access control.

      Valid values: on | off. Default value: off'
    Type: String
  AclType:
    AllowedValues:
    - white
    - black
    Description: 'The access control type:

      * white: Indicates a whitelist. Only requests from IP addresses or CIDR blocks
      in the selected access control lists are forwarded. This applies to scenarios
      in which an application only allows access from specific IP addresses.

      Enabling a whitelist poses some risks to your services.

      After a whitelist is enabled, only the IP addresses in the list can access the
      listener.

      If you enable a whitelist without adding any IP addresses in the list, no requests
      are forwarded.

      * black: Indicates a blacklist. Requests from IP addresses or CIDR blocks in
      the selected access control lists are not forwarded (that is, they are blocked).
      This applies to scenarios in which an application only denies access from specific
      IP addresses.

      If you enable a blacklist without adding any IP addresses in the list, all requests
      are forwarded.


      If the value of the AclStatus parameter is on, this parameter is required.'
    Type: String
  BackendServerPort:
    Description: Backend server can listen on ports from 1 to 65535.
    MaxValue: 65535
    MinValue: 1
    Type: Number
  Bandwidth:
    Description: The bandwidth of network, unit in Mbps(Million bits per second).
      If the specified load balancer with "LOAD_BALANCE_ID" is charged by "paybybandwidth"
      and is created in classic network, each Listener's bandwidth must be greater
      than 0 and the sum of all of its Listeners' bandwidth can't be greater than
      the bandwidth of the load balancer.
    MaxValue: 1000
    MinValue: -1
    Type: Number
  CACertificateId:
    Description: CA server certificate id, for https listener only.
    Type: String
  Description:
    Description: The description of the listener.It must be 1 to 80 characters in
      length and can contain letters, digits, hyphens (-), forward slashes (/), periods
      (.), and underscores (_). Chinese characters are supported.
    MaxLength: 80
    Type: String
  HealthCheck:
    Description: The properties of health checking setting.
    Type: Json
  HttpConfig:
    Description: Config for http protocol.
    Type: Json
  IdleTimeout:
    Description: 'Specify the idle connection timeout in seconds. Valid value: 1-60
      If no request is received during the specified timeout period, Server Load Balancer
      will temporarily terminate the connection and restart the connection when the
      next request comes.'
    MaxValue: 60
    MinValue: 1
    Type: Number
  ListenerPort:
    Description: Port for front listener. Range from 0 to 65535.
    MaxValue: 65535
    MinValue: 0
    Type: Number
  LoadBalancerId:
    Description: The id of load balancer to create listener.
    Type: String
  MasterSlaveServerGroupId:
    Description: The id of the MasterSlaveServerGroup which use in listener.
    Type: String
  Persistence:
    Description: The properties of persistence.
    Type: Json
  PortRange:
    Description: Port range, only supports TCP or UDP listener. ListenerPort should
      be 0 when PortRange is specified.
    MaxLength: 1
    MinLength: 1
    Type: Json
  Protocol:
    AllowedValues:
    - http
    - https
    - tcp
    - udp
    Description: 'The load balancer transport protocol to use for routing: http, https,
      tcp, or udp.'
    Type: String
  RequestTimeout:
    Description: 'Specify the request timeout in seconds. Valid value: 1-180 If no
      response is received from the backend server during the specified timeout period,
      Server Load Balancer will stop waiting and send an HTTP 504 error to the client.'
    MaxValue: 180
    MinValue: 1
    Type: Number
  Scheduler:
    AllowedValues:
    - wrr
    - wlc
    - rr
    - sch
    - tch
    Default: wrr
    Description: 'The scheduling algorithm. Valid values:

      wrr: Backend servers that have higher weights receive more requests than those
      that have lower weights.

      wlc: Requests are distributed based on the combination of the weights and connections
      to backend servers. If two backend servers have the same weight, the backend
      server that has fewer connections receives more requests.

      rr: Requests are distributed to backend servers in sequence.

      sch: specifies consistent hashing that is based on source IP addresses. Requests
      from the same source IP address are distributed to the same backend server.

      tch: specifies consistent hashing that is based on four factors: source IP address,
      destination IP address, source port number, and destination port number. Requests
      that contain the same preceding information are distributed to the same backend
      server.

      Default: wrr'
    Type: String
  ServerCertificateId:
    Description: Server certificate id, for https listener only, this properties is
      required.
    Type: String
  VServerGroupId:
    Description: The id of the VServerGroup which use in listener.
    Type: String
Resources:
  Listener:
    Properties:
      AclId:
        Ref: AclId
      AclStatus:
        Ref: AclStatus
      AclType:
        Ref: AclType
      BackendServerPort:
        Ref: BackendServerPort
      Bandwidth:
        Ref: Bandwidth
      CACertificateId:
        Ref: CACertificateId
      Description:
        Ref: Description
      HealthCheck:
        Ref: HealthCheck
      HttpConfig:
        Ref: HttpConfig
      IdleTimeout:
        Ref: IdleTimeout
      ListenerPort:
        Ref: ListenerPort
      LoadBalancerId:
        Ref: LoadBalancerId
      MasterSlaveServerGroupId:
        Ref: MasterSlaveServerGroupId
      Persistence:
        Ref: Persistence
      PortRange:
        Ref: PortRange
      Protocol:
        Ref: Protocol
      RequestTimeout:
        Ref: RequestTimeout
      Scheduler:
        Ref: Scheduler
      ServerCertificateId:
        Ref: ServerCertificateId
      VServerGroupId:
        Ref: VServerGroupId
    Type: ALIYUN::SLB::Listener
Outputs:
  ListenerPortsAndProtocol:
    Description: The collection of listener.
    Value:
      Fn::GetAtt:
      - Listener
      - ListenerPortsAndProtocol
  LoadBalancerId:
    Description: The id of load balancer
    Value:
      Fn::GetAtt:
      - Listener
      - LoadBalancerId
            

To view more examples, visit Listener.json and Listener.yml. In the examples, the ALIYUN::SLB::Listener, ALIYUN::SLB::LoadBalancerClone, ALIYUN::SLB::Certificate, ALIYUN::SLB::DomainExtension, ALIYUN::SLB::VServerGroup, ALIYUN::SLB::Rule, and ALIYUN::SLB::BackendServerToVServerGroupAddition resource types are involved.