Skip to content

ListenerProps

Properties for defining a Listener.

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

Initializer 

import { ListenerProps } from '@alicloud/ros-cdk-alb'
const listenerProps: ListenerProps = { ... }

Properties

Name Type Description
defaultActions @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DefaultActionsProperty[] Property defaultActions: The actions of the rule.
listenerPort number | @alicloud/ros-cdk-core.IResolvable Property listenerPort: The frontend port that is used by the ALB instance.
listenerProtocol string | @alicloud/ros-cdk-core.IResolvable Property listenerProtocol: The listener protocol.
loadBalancerId string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerId: The ID of the ALB instance.
caCertificates @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CaCertificatesProperty[] Property caCertificates: List of configured CA certificates for listener.
caEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property caEnabled: Specifies whether to enable mutual authentication.
certificates @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CertificatesProperty[] Property certificates: The list of SSL certificates for listener.
gzipEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property gzipEnabled: Specifies whether to enable gzip compression to compress files of a specific type.
http2Enabled boolean | @alicloud/ros-cdk-core.IResolvable Property http2Enabled: Specifies whether to enable HTTP\/2.
idleTimeout number | @alicloud/ros-cdk-core.IResolvable Property idleTimeout: The timeout period of idle connections.
listenerDescription string | @alicloud/ros-cdk-core.IResolvable Property listenerDescription: The description of the listener.
listenerStatus string | @alicloud/ros-cdk-core.IResolvable Property listenerStatus: The status of the listener.
quicConfig @alicloud/ros-cdk-core.IResolvable | QuicConfigProperty Property quicConfig: Select a QUIC listener and associate it with the ALB instance.
requestTimeout number | @alicloud/ros-cdk-core.IResolvable Property requestTimeout: The timeout period of the request.
securityPolicyId string | @alicloud/ros-cdk-core.IResolvable Property securityPolicyId: The ID of the security policy.
xForwardedForConfig @alicloud/ros-cdk-core.IResolvable | XForwardedForConfigProperty Property xForwardedForConfig: The configuration of the XForward field.

defaultActionsRequired 

public readonly defaultActions: IResolvable | IResolvable | DefaultActionsProperty[];

Property defaultActions: The actions of the rule.

listenerPortRequired 

public readonly listenerPort: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

Valid values: 1 to 65535.

listenerProtocolRequired 

public readonly listenerProtocol: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property listenerProtocol: The listener protocol.

Valid values: HTTP, HTTPS, and QUIC.

loadBalancerIdRequired 

public readonly loadBalancerId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property loadBalancerId: The ID of the ALB instance.

caCertificatesOptional 

public readonly caCertificates: IResolvable | IResolvable | CaCertificatesProperty[];

Property caCertificates: List of configured CA certificates for listener.

caEnabledOptional 

public readonly caEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property caEnabled: Specifies whether to enable mutual authentication.

Default false.

certificatesOptional 

public readonly certificates: IResolvable | IResolvable | CertificatesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CertificatesProperty[]

Property certificates: The list of SSL certificates for listener.

gzipEnabledOptional 

public readonly gzipEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

http2EnabledOptional 

public readonly http2Enabled: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

idleTimeoutOptional 

public readonly idleTimeout: number | IResolvable;
  • Type: number | @alicloud/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.

listenerDescriptionOptional 

public readonly listenerDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property listenerDescription: The description of the listener.

The description must be 2 to 256 characters in length.

listenerStatusOptional 

public readonly listenerStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property listenerStatus: The status of the listener.

quicConfigOptional 

public readonly quicConfig: IResolvable | QuicConfigProperty;

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

requestTimeoutOptional 

public readonly requestTimeout: number | IResolvable;
  • Type: number | @alicloud/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.

securityPolicyIdOptional 

public readonly securityPolicyId: string | IResolvable;
  • Type: string | @alicloud/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.

xForwardedForConfigOptional 

public readonly xForwardedForConfig: IResolvable | XForwardedForConfigProperty;

Property xForwardedForConfig: The configuration of the XForward field.