Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer 

import ros_cdk_alb
ros_cdk_alb.ListenerProps(
  default_actions: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DefaultActionsProperty]]],
  listener_port: typing.Union[typing.Union[int, float], IResolvable],
  listener_protocol: typing.Union[str, IResolvable],
  load_balancer_id: typing.Union[str, IResolvable],
  ca_certificates: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CaCertificatesProperty]]] = None,
  ca_enabled: typing.Union[bool, IResolvable] = None,
  certificates: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, CertificatesProperty]]] = None,
  gzip_enabled: typing.Union[bool, IResolvable] = None,
  http2_enabled: typing.Union[bool, IResolvable] = None,
  idle_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  listener_description: typing.Union[str, IResolvable] = None,
  listener_status: typing.Union[str, IResolvable] = None,
  quic_config: typing.Union[IResolvable, QuicConfigProperty] = None,
  request_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  security_policy_id: typing.Union[str, IResolvable] = None,
  x_forwarded_for_config: typing.Union[IResolvable, XForwardedForConfigProperty] = None
)

Properties

Name Type Description
default_actions typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DefaultActionsProperty]]] Property defaultActions: The actions of the rule.
listener_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property listenerPort: The frontend port that is used by the ALB instance.
listener_protocol typing.Union[str, ros_cdk_core.IResolvable] Property listenerProtocol: The listener protocol.
load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerId: The ID of the ALB instance.
ca_certificates typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CaCertificatesProperty]]] Property caCertificates: List of configured CA certificates for listener.
ca_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property caEnabled: Specifies whether to enable mutual authentication.
certificates typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, CertificatesProperty]]] Property certificates: The list of SSL certificates for listener.
gzip_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.
http2_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property http2Enabled: Specifies whether to enable HTTP\/2.
idle_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property idleTimeout: The timeout period of idle connections.
listener_description typing.Union[str, ros_cdk_core.IResolvable] Property listenerDescription: The description of the listener.
listener_status typing.Union[str, ros_cdk_core.IResolvable] Property listenerStatus: The status of the listener.
quic_config typing.Union[ros_cdk_core.IResolvable, QuicConfigProperty] Property quicConfig: Select a QUIC listener and associate it with the ALB instance.
request_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property requestTimeout: The timeout period of the request.
security_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property securityPolicyId: The ID of the security policy.
x_forwarded_for_config typing.Union[ros_cdk_core.IResolvable, XForwardedForConfigProperty] Property xForwardedForConfig: The configuration of the XForward field.

default_actionsRequired 

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

Property defaultActions: The actions of the rule.

listener_portRequired 

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

Property listenerPort: The frontend port that is used by the ALB instance.

Valid values: 1 to 65535.

listener_protocolRequired 

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

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.

load_balancer_idRequired 

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

Property loadBalancerId: The ID of the ALB instance.

ca_certificatesOptional 

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

Property caCertificates: List of configured CA certificates for listener.

ca_enabledOptional 

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

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.

certificatesOptional 

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

Property certificates: The list of SSL certificates for listener.

gzip_enabledOptional 

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

Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.

Valid values: true and false. Default value: true.

http2_enabledOptional 

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

Property http2Enabled: Specifies whether to enable HTTP\/2.

Default value: on. Valid values: true and false. Default value: true. Note Only HTTPS listeners support this parameter.

idle_timeoutOptional 

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

Property idleTimeout: The timeout period of idle connections.

Valid values: 1 to 180. Unit: seconds. Default value: 15. If no request is received within the specified timeout period, ALB closes the connection. ALB recreates the connection when a new connection request is received.

listener_descriptionOptional 

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

Property listenerDescription: The description of the listener.

The description must be 2 to 256 characters in length.

listener_statusOptional 

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

Property listenerStatus: The status of the listener.

quic_configOptional 

quic_config: typing.Union[IResolvable, QuicConfigProperty]

Property quicConfig: Select a QUIC listener and associate it with the ALB instance.

request_timeoutOptional 

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

Property requestTimeout: The timeout period of the request.

Valid values: 1 to 180. Unit: seconds. Default value: 60. If no response is received from the backend server during the request timeout period, ALB sends an HTTP 504 error code to the client.

security_policy_idOptional 

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

Property securityPolicyId: The ID of the security policy.

System security policies and custom security policies are supported. Default value: tls_cipher_policy_1_0. This value indicates a system security policy. Note Only HTTPS listeners support this parameter.

x_forwarded_for_configOptional 

x_forwarded_for_config: typing.Union[IResolvable, XForwardedForConfigProperty]

Property xForwardedForConfig: The configuration of the XForward field.