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,
  log_config: typing.Union[IResolvable, LogConfigProperty] = 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

default_actions^Required

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 default actions for the listener.

listener_port^Required

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_protocol^Required

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_id^Required

load_balancer_id: typing.Union[str, IResolvable]

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

Property loadBalancerId: The ID of the ALB instance.

ca_certificates^Optional

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: A list of CA certificates for the listener.

Only one CA certificate is supported.

ca_enabled^Optional

ca_enabled: typing.Union[bool, IResolvable]

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

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.

certificates^Optional

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: A list of server certificates.

gzip_enabled^Optional

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

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_timeout^Optional

idle_timeout: typing.Union[typing.Union[int, float], IResolvable]

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

Property idleTimeout: The idle timeout in seconds.

Valid values: 1 to 600. Default value: 15. If no requests are received on a connection within the idle timeout, the load balancer closes the connection. A new connection is established for the next request.

You can request a quota increase to a maximum of 3,600 seconds.

listener_description^Optional

listener_description: typing.Union[str, IResolvable]

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

Property listenerDescription: A custom name for the listener.

The name must be 2 to 256 characters long and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), underscores (_), and Chinese characters.

listener_status^Optional

listener_status: typing.Union[str, IResolvable]

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

Property listenerStatus: The status of the listener.

log_config^Optional

log_config: typing.Union[IResolvable, LogConfigProperty]

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

Property logConfig: The configuration information about the access log.

quic_config^Optional

quic_config: typing.Union[IResolvable, QuicConfigProperty]

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

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

request_timeout^Optional

request_timeout: typing.Union[typing.Union[int, float], IResolvable]

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

Property requestTimeout: The request timeout in seconds.

Valid values: 1 to 600. Default value: 60. If a backend server does not respond within the timeout period, the load balancer returns an HTTP 504 error to the client.

You can request a quota increase to a maximum of 3,600 seconds.

security_policy_id^Optional

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_config^Optional

x_forwarded_for_config: typing.Union[IResolvable, XForwardedForConfigProperty]

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

Property xForwardedForConfig: The configuration of X-Forwarded-* headers.