調用ALIYUN::NLB::Listener建立監聽 -

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,
    "ServerGroupTuples": List,
    "ProxyProtocolV2Config": Map
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ListenerPort	Integer	是	否	Server Load Balancer執行個體前端使用的連接埠。	取值範圍：1~65535。
ListenerProtocol	String	是	否	Server Load Balancer執行個體前端使用的協議。	取值： TCP UDP TCPSSL
LoadBalancerId	String	是	否	Server Load Balancer執行個體ID。	無
AlpnEnabled	Boolean	否	是	是否啟用Alpn代理。	取值： true：啟用。 false：不啟用。
AlpnPolicy	String	否	是	Alpn代理。	無
CaCertificateIds	List	否	否	CA簽署憑證ID。	無
CaEnabled	Boolean	否	是	是否開啟雙向認證。	取值： true：開啟。 false（預設值）：不開啟。
CertificateIds	List	否	是	簽署憑證ID。	無
Cps	Integer	否	是	每秒建立串連數。	取值：3000。
Enable	Boolean	否	否	是否啟用監聽。	取值： true：啟用。 false：不啟用。
EndPort	Integer	否	否	監聽的終止連接埠。	取值：65535。
IdleTimeout	Integer	否	是	指定串連空閑逾時時間。	取值範圍：1~60。單位：秒。
ListenerDescription	String	否	是	設定監聽的描述資訊。	長度為2~256個字元。可包含中文、字母、數字、短劃線（-）、正斜線（/）、半形句號（.）、底線（_）。
Mss	Integer	否	是	MSS自動協商。	無
ProxyProtocolEnabled	Boolean	否	是	是否啟用ppv2代理。	取值： true：啟用。 false：不啟用。
ProxyProtocolV2Config	Map	否	是	通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 資訊到後端伺服器配置。	更多資訊，請參見ProxyProtocolV2Config屬性。
SecSensorEnabled	Boolean	否	是	是否啟用二級監控。	取值： true：啟用。 false：不啟用。
SecurityPolicyId	String	否	是	安全性原則ID。	無
ServerGroupId	String	否	是	轉寄到的目的伺服器組ID。	無
ServerGroupTuples	List	否	是	轉寄目標伺服器元組。	包含多個轉寄到的目的伺服器組 ID的組合，更多資訊，請參考ServerGroupTuples屬性。
StartPort	Integer	否	否	監聽的開始端點口。	取值：1。
Tags	List	否	是	標籤列表。	更多資訊，請參見Tags屬性。

ServerGroupTuples文法

"ServerGroupTuples": [{
    "ServerGroupId": String,
    "Weight": Integer
}]

ServerGroupTuples屬性

屬性名稱	類型	必須	允許更新	描述	約束
ServerGroupId	String	否	是	轉寄到的目的伺服器組 ID。	無
Weight	Integer	否	是	權重。	取值越大，權重越大，表示轉寄的訪問請求更多。取值範圍：0~100。

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