全部產品
Search
文件中心

:ALIYUN::NLB::Listener

更新時間:Sep 19, 2024

ALIYUN::NLB::Listener類型用於建立監聽。

文法

{
  "Type": "ALIYUN::NLB::Listener",
  "Properties": {
    "CaEnabled": Boolean,
    "ListenerPort": Integer,
    "StartPort": Integer,
    "Cps": Integer,
    "ServerGroupId": String,
    "IdleTimeout": Integer,
    "LoadBalancerId": String,
    "Mss": Integer,
    "ListenerProtocol": String,
    "SecurityPolicyId": String,
    "ListenerDescription": String,
    "AlpnPolicy": String,
    "CaCertificateIds": List,
    "EndPort": Integer,
    "ProxyProtocolEnabled": Boolean,
    "CertificateIds": List,
    "SecSensorEnabled": Boolean,
    "Enable": Boolean,
    "AlpnEnabled": Boolean,
    "Tags": List,
    "ProxyProtocolV2Config": Map
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

CaEnabled

Boolean

是否開啟雙向認證。

取值:

  • true:開啟。

  • false(預設值):不開啟。

ListenerPort

Integer

Server Load Balancer執行個體前端使用的連接埠。

取值範圍:1~65535。

StartPort

Integer

監聽的開始端點口。

取值:1。

Cps

Integer

每秒建立串連數。

取值:3000。

ServerGroupId

String

轉寄到的目的伺服器組ID。

IdleTimeout

Integer

指定串連空閑逾時時間。

取值範圍:1~60。 單位:秒。

LoadBalancerId

String

Server Load Balancer執行個體ID。

Mss

Integer

MSS自動協商。

ListenerProtocol

String

Server Load Balancer執行個體前端使用的協議。

取值:

  • TCP

  • UDP

  • TCPSSL

SecurityPolicyId

String

安全性原則ID。

ListenerDescription

String

設定監聽的描述資訊。

長度為2~256個字元。可包含中文、字母、數字、短劃線(-)、正斜線(/)、半形句號(.)、底線(_)。

AlpnPolicy

String

Alpn代理。

CaCertificateIds

List

CA簽署憑證ID。

EndPort

Integer

監聽的終止連接埠。

取值:65535。

ProxyProtocolEnabled

Boolean

是否啟用ppv2代理。

取值:

  • true:啟用。

  • false:不啟用。

CertificateIds

List

簽署憑證ID。

SecSensorEnabled

Boolean

是否啟用二級監控。

取值:

  • true:啟用。

  • false:不啟用。

Enable

Boolean

是否啟用監聽。

取值:

  • true:啟用。

  • false:不啟用。

AlpnEnabled

Boolean

是否啟用Alpn代理。

取值:

  • true:啟用。

  • false:不啟用。

Tags

List

標籤列表。

更多資訊,請參見Tags屬性

ProxyProtocolV2Config

Map

通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 資訊到後端伺服器配置。

更多資訊,請參見ProxyProtocolV2Config屬性。

ProxyProtocolV2Config文法

"ProxyProtocolV2Config": {
    "Ppv2PrivateLinkEpIdEnabled": Boolean,
    "Ppv2PrivateLinkEpsIdEnabled": Boolean,
    "Ppv2VpcIdEnabled": Boolean
  }

ProxyProtocolV2Config屬性

屬性名稱

類型

必須

允許更新

描述

約束

Ppv2PrivateLinkEpIdEnabled

Boolean

是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpId 到後端伺服器。

取值:

  • true:開啟。

  • false:關閉。

Ppv2PrivateLinkEpsIdEnabled

Boolean

是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpsId 到後端伺服器。

取值:

  • true:開啟。

  • false:關閉。

Ppv2VpcIdEnabled

Boolean

是否開啟通過 Proxy Protocol 協議攜帶 VpcId 到後端伺服器。

取值:

  • true:開啟。

  • false:關閉。

Tags文法

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Key

String

標籤鍵。

Value

String

標籤值。

傳回值

Fn::GetAtt

  • ListenerPort:Server Load Balancer執行個體前端使用的連接埠。

  • ListenerId:監聽ID。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServerGroupId:
    Type: String
    Description: ID of the ServerGroup
  LoadBalancerId:
    Type: String
    Description: ID of the LoadBalancer
  ListenerProtocol:
    Type: String
    AllowedValues:
      - TCP
      - UDP
      - TCPSSL
Resources:
  ExtensionResource:
    Type: ALIYUN::NLB::Listener
    Properties:
      ServerGroupId:
        Ref: ServerGroupId
      LoadBalancerId:
        Ref: LoadBalancerId
      ListenerProtocol:
        Ref: ListenerProtocol
Outputs:
  ListenerPort:
    Description: ListenerPort of created Listener
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerPort
  ListenerId:
    Description: Id of created Listener
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ListenerId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServerGroupId": {
      "Type": "String",
      "Description": "ID of the ServerGroup"
    },
    "LoadBalancerId": {
      "Type": "String",
      "Description": "ID of the LoadBalancer"
    },
    "ListenerProtocol": {
      "Type": "String",
      "AllowedValues": [
        "TCP",
        "UDP",
        "TCPSSL"
      ]
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::NLB::Listener",
      "Properties": {
        "ServerGroupId": {
          "Ref": "ServerGroupId"
        },
        "LoadBalancerId": {
          "Ref": "LoadBalancerId"
        },
        "ListenerProtocol": {
          "Ref": "ListenerProtocol"
        }
      }
    }
  },
  "Outputs": {
    "ListenerPort": {
      "Description": "ListenerPort of created Listener",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerPort"
        ]
      }
    },
    "ListenerId": {
      "Description": "Id of created Listener",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ListenerId"
        ]
      }
    }
  }
}