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

Properties

HealthCheck syntax

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

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

Response parameters

Fn::GetAtt

• LoadBalancerId: the unique ID of the SLB instance.
• ListenerPortsAndProtocol: an array that consists of 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 1 to 65535.",
      "MinValue": 1,
      "MaxValue": 65535
    },
    "VServerGroupId": {
      "Type": "String",
      "Description": "The id of the VServerGroup which use in listener."
    },
    "CACertificateId": {
      "Type": "String",
      "Description": "CA server certificate id, for https listener only."
    },
    "Scheduler": {
      "Type": "String",
      "Description": "The scheduler algorithm. Support 'wrr' or 'wlc' only, default is 'wrr'",
      "AllowedValues": [
        "wrr",
        "wlc"
      ],
      "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."
    },
    "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"
        },
        "CACertificateId": {
          "Ref": "CACertificateId"
        },
        "Scheduler": {
          "Ref": "Scheduler"
        },
        "AclId": {
          "Ref": "AclId"
        },
        "HealthCheck": {
          "Ref": "HealthCheck"
        },
        "IdleTimeout": {
          "Ref": "IdleTimeout"
        },
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        },
        "BackendServerPort": {
          "Ref": "BackendServerPort"
        },
        "Persistence": {
          "Ref": "Persistence"
        },
        "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:
  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 1 to 65535.
    MinValue: 1
    MaxValue: 65535
  VServerGroupId:
    Type: String
    Description: The id of the VServerGroup which use in listener.
  CACertificateId:
    Type: String
    Description: 'CA server certificate id, for https listener only.'
  Scheduler:
    Type: String
    Description: 'The scheduler algorithm. Support ''wrr'' or ''wlc'' only, default is ''wrr'''
    AllowedValues:
      - wrr
      - wlc
    Default: wrr
  AclId:
    Type: String
    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.
  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.
  AclStatus:
    Type: String
    Description: |-
      Indicates whether to enable access control.
      Valid 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:
      * 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.
    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
      CACertificateId:
        Ref: CACertificateId
      Scheduler:
        Ref: Scheduler
      AclId:
        Ref: AclId
      HealthCheck:
        Ref: HealthCheck
      IdleTimeout:
        Ref: IdleTimeout
      LoadBalancerId:
        Ref: LoadBalancerId
      BackendServerPort:
        Ref: BackendServerPort
      Persistence:
        Ref: Persistence
      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