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 |
是 |
否 |
负载均衡实例前端使用的端口。 |
取值范围:1~65535。 |
|
ListenerProtocol |
String |
是 |
否 |
负载均衡实例前端使用的协议。 |
取值:
|
|
LoadBalancerId |
String |
是 |
否 |
负载均衡实例ID。 |
无 |
|
AlpnEnabled |
Boolean |
否 |
是 |
是否启用Alpn代理。 |
取值:
|
|
AlpnPolicy |
String |
否 |
是 |
Alpn代理。 |
无 |
|
CaCertificateIds |
List |
否 |
否 |
CA签名证书ID。 |
无 |
|
CaEnabled |
Boolean |
否 |
是 |
是否开启双向认证。 |
取值:
|
|
CertificateIds |
List |
否 |
是 |
签名证书ID。 |
无 |
|
Cps |
Integer |
否 |
是 |
每秒新建连接数。 |
取值:3000。 |
|
Enable |
Boolean |
否 |
否 |
是否启用监听。 |
取值:
|
|
EndPort |
Integer |
否 |
否 |
监听的终止端口。 |
取值:65535。 |
|
IdleTimeout |
Integer |
否 |
是 |
指定连接空闲超时时间。 |
取值范围:1~60。 单位:秒。 |
|
ListenerDescription |
String |
否 |
是 |
设置监听的描述信息。 |
长度为2~256个字符。可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)、下划线(_)。 |
|
Mss |
Integer |
否 |
是 |
MSS自动协商。 |
无 |
|
ProxyProtocolEnabled |
Boolean |
否 |
是 |
是否启用ppv2代理。 |
取值:
|
|
ProxyProtocolV2Config |
Map |
否 |
是 |
通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。 |
更多信息,请参见ProxyProtocolV2Config属性。 |
|
SecSensorEnabled |
Boolean |
否 |
是 |
是否启用二级监控。 |
取值:
|
|
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 到后端服务器。 |
取值:
|
|
Ppv2PrivateLinkEpsIdEnabled |
Boolean |
否 |
是 |
是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。 |
取值:
|
|
Ppv2VpcIdEnabled |
Boolean |
否 |
是 |
是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。 |
取值:
|
Tags语法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags属性
|
属性名称 |
类型 |
必须 |
允许更新 |
描述 |
约束 |
|
Key |
String |
是 |
否 |
标签键。 |
无 |
|
Value |
String |
否 |
否 |
标签值。 |
无 |
返回值
Fn::GetAtt
-
ListenerPort:负载均衡实例前端使用的端口。
-
ListenerId:监听ID。
-
ServerGroupTuples:转发到的目的服务器组列表。
-
CertificateIds:签名证书ID。
-
Mss:MSS自动协商。
-
ServerGroupId:转发到的目的服务器组ID。
-
AlpnPolicy:Alpn代理。
-
ProxyProtocolEnabled:是否启用ppv2代理。
-
Tags:标签列表。
-
SecSensorEnabled:是否启用二级监控。
-
Cps:每秒新建连接数。
-
EndPort:监听的终止端口。
-
CaCertificateIds:CA签名证书ID。
-
LoadBalancerId:负载均衡实例ID。
-
ListenerProtocol:负载均衡实例前端使用的协议。
-
ListenerDescription:设置监听的描述信息。
-
ProxyProtocolV2Config:通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。
-
CaEnabled:是否开启双向认证。
-
SecurityPolicyId:安全策略ID。
-
AlpnEnabled:是否启用Alpn代理。
-
StartPort:监听的起始端口。
-
IdleTimeout:指定连接空闲超时时间。
示例
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
{
"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"
]
}
}
}
}