Listener

This class encapsulates and extends the ROS resource type ALIYUN::NLB::Listener, which is used to create a listener.

Initializers

import ros_cdk_nlb
ros_cdk_nlb.Listener(
  scope: Construct,
  id: str,
  listener_protocol: typing.Union[str, IResolvable],
  load_balancer_id: typing.Union[str, IResolvable],
  server_group_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,
  listener_port: typing.Union[typing.Union[int, float], 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,
  start_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
listener_protocol	typing.Union[str, ros_cdk_core.IResolvable]	Property listenerProtocol: undefined.
load_balancer_id	typing.Union[str, ros_cdk_core.IResolvable]	Property loadBalancerId: ID of the LoadBalancer.
server_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property serverGroupId: ID of the ServerGroup.
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.
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.
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.
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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

listener_protocol^Required

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

Property listenerProtocol: undefined.

---

load_balancer_id^Required

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

Property loadBalancerId: ID of the LoadBalancer.

---

server_group_id^Required

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

Property serverGroupId: ID of the ServerGroup.

---

alpn_enabled^Optional

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

Property alpnEnabled: undefined.

---

alpn_policy^Optional

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

Property alpnPolicy: Proxy of alpn.

---

ca_certificate_ids^Optional

• 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_enabled^Optional

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

Property caEnabled: Whether to open CA.

---

certificate_ids^Optional

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

Property certificateIds: List of the certificate ids.

---

cps^Optional

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

Property cps: New connection rate limit of Instance.

---

enable^Optional

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

Property enable: Whether to start listener or not.

Default True.

---

end_port^Optional

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

Property endPort: EndPort of the portRange.

---

idle_timeout^Optional

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

Property idleTimeout: Specifies the connection idle timeout.

---

listener_description^Optional

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

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

---

listener_port^Optional

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

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

---

mss^Optional

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

Property mss: Max length of the TCP packet.

---

proxy_protocol_enabled^Optional

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

Property proxyProtocolEnabled: Whether to enable ppv2 function.

---

proxy_protocol_v2_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, ProxyProtocolV2ConfigProperty]

Property proxyProtocolV2Config: ProxyProtocolV2Config of the listener.

---

sec_sensor_enabled^Optional

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

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

---

security_policy_id^Optional

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

Property securityPolicyId: Only valid for TcpSSL protocol monitoring.

---

start_port^Optional

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

Property startPort: StartPort of the portRange.

---

tags^Optional

• Type: 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_nlb
ros_cdk_nlb.Listener.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_listener_id	ros_cdk_core.IResolvable	Attribute ListenerId: Id of created Listener.
attr_listener_port	ros_cdk_core.IResolvable	Attribute ListenerPort: ListenerPort of created Listener.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_listener_id^Required

attr_listener_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ListenerId: Id of created Listener.

---

attr_listener_port^Required

attr_listener_port: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ListenerPort: ListenerPort of created Listener.

---