Skip to content

ListenerProps

Properties for defining a Listener.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-nlb-listener

Initializer

import ros_cdk_nlb
ros_cdk_nlb.ListenerProps(
  listener_port: typing.Union[typing.Union[int, float], IResolvable],
  listener_protocol: typing.Union[str, IResolvable],
  load_balancer_id: typing.Union[str, IResolvable],
  alpn_enabled: typing.Union[bool, IResolvable] = None,
  alpn_policy: typing.Union[str, IResolvable] = None,
  ca_certificate_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ca_enabled: typing.Union[bool, IResolvable] = None,
  certificate_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  cps: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable: typing.Union[bool, IResolvable] = None,
  end_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  idle_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  listener_description: typing.Union[str, IResolvable] = None,
  mss: typing.Union[typing.Union[int, float], IResolvable] = None,
  proxy_protocol_enabled: typing.Union[bool, IResolvable] = None,
  proxy_protocol_v2_config: typing.Union[IResolvable, ProxyProtocolV2ConfigProperty] = None,
  sec_sensor_enabled: typing.Union[bool, IResolvable] = None,
  security_policy_id: typing.Union[str, IResolvable] = None,
  server_group_id: typing.Union[str, IResolvable] = None,
  server_group_tuples: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServerGroupTuplesProperty]]] = None,
  start_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
listener_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property listenerPort: Port of the listener,[0, 65535] the portRange setting need 0.
listener_protocol typing.Union[str, ros_cdk_core.IResolvable] Property listenerProtocol: Listening protocol.
load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerId: ID of the LoadBalancer.
alpn_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property alpnEnabled: undefined.
alpn_policy typing.Union[str, ros_cdk_core.IResolvable] Property alpnPolicy: Proxy of alpn.
ca_certificate_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property caCertificateIds: List of the ca certificate ids.
ca_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property caEnabled: Whether to open CA.
certificate_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property certificateIds: List of the certificate ids.
cps typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cps: New connection rate limit of Instance.
enable typing.Union[bool, ros_cdk_core.IResolvable] Property enable: Whether to start listener or not.
end_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property endPort: EndPort of the portRange.
idle_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property idleTimeout: Specifies the connection idle timeout.
listener_description typing.Union[str, ros_cdk_core.IResolvable] Property listenerDescription: Description of the listener, [2, 256] characters.
mss typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property mss: Max length of the TCP packet.
proxy_protocol_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property proxyProtocolEnabled: Whether to enable ppv2 function.
proxy_protocol_v2_config typing.Union[ros_cdk_core.IResolvable, ProxyProtocolV2ConfigProperty] Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.
sec_sensor_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property secSensorEnabled: Whether to enable the second-level monitoring function.
security_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property securityPolicyId: Only valid for TcpSSL protocol monitoring.
server_group_id typing.Union[str, ros_cdk_core.IResolvable] Property serverGroupId: ID of the ServerGroup.
server_group_tuples typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServerGroupTuplesProperty]]] Property serverGroupTuples: Multi-server group list.
start_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property startPort: StartPort of the portRange.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.

listener_portRequired

listener_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property listenerPort: Port of the listener,[0, 65535] the portRange setting need 0.


listener_protocolRequired

listener_protocol: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property listenerProtocol: Listening protocol.

Values: TCP, UDP, or TCPSSL.


load_balancer_idRequired

load_balancer_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property loadBalancerId: ID of the LoadBalancer.


alpn_enabledOptional

alpn_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property alpnEnabled: undefined.


alpn_policyOptional

alpn_policy: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property alpnPolicy: Proxy of alpn.


ca_certificate_idsOptional

ca_certificate_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property caCertificateIds: List of the ca certificate ids.


ca_enabledOptional

ca_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property caEnabled: Whether to open CA.


certificate_idsOptional

certificate_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property certificateIds: List of the certificate ids.


cpsOptional

cps: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property cps: New connection rate limit of Instance.


enableOptional

enable: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enable: Whether to start listener or not.

Default True.


end_portOptional

end_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property endPort: EndPort of the portRange.


idle_timeoutOptional

idle_timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property idleTimeout: Specifies the connection idle timeout.


listener_descriptionOptional

listener_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property listenerDescription: Description of the listener, [2, 256] characters.


mssOptional

mss: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property mss: Max length of the TCP packet.


proxy_protocol_enabledOptional

proxy_protocol_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property proxyProtocolEnabled: Whether to enable ppv2 function.


proxy_protocol_v2_configOptional

proxy_protocol_v2_config: typing.Union[IResolvable, ProxyProtocolV2ConfigProperty]

Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.


sec_sensor_enabledOptional

sec_sensor_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property secSensorEnabled: Whether to enable the second-level monitoring function.


security_policy_idOptional

security_policy_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityPolicyId: Only valid for TcpSSL protocol monitoring.


server_group_idOptional

server_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property serverGroupId: ID of the ServerGroup.


server_group_tuplesOptional

server_group_tuples: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServerGroupTuplesProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServerGroupTuplesProperty]]]

Property serverGroupTuples: Multi-server group list.

When the number of destination server groups is 1, the default value is 100 if no weight is specified. When the number of destination server groups is greater than 1, the user needs to specify the weight value.


start_portOptional

start_port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property startPort: StartPort of the portRange.


tagsOptional

tags: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.