WaitingRoomProps

Properties for defining a WaitingRoom.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-waitingroom

Initializer

import { WaitingRoomProps } from '@alicloud/ros-cdk-esa'
const waitingRoomProps: WaitingRoomProps = { ... }

Properties

cookieName^Required

public readonly cookieName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property cookieName: The name of the custom cookie.

hostNameAndPath^Required

public readonly hostNameAndPath: IResolvable | IResolvable | HostNameAndPathProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | HostNameAndPathProperty[]

Property hostNameAndPath: The hostname and path.

newUsersPerMinute^Required

public readonly newUsersPerMinute: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property newUsersPerMinute: The maximum number of new users per minute.

queuingMethod^Required

public readonly queuingMethod: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property queuingMethod: The queuing method.

Value: - random: Users gain access to the origin randomly, regardless of the arrival time. - fifo: Users gain access to the origin in order of arrival. - Passthrough: Users pass through the waiting room and go straight to the origin. - Reject-all: Users are blocked from reaching the origin.

queuingStatusCode^Required

public readonly queuingStatusCode: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property queuingStatusCode: Waiting room status code.

Value: - 200 - 202 - 429.

sessionDuration^Required

public readonly sessionDuration: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin.

Unit: minutes.

siteId^Required

public readonly siteId: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property siteId: The site ID.

status^Required

public readonly status: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property status: Waiting room enabled status.

Value: - 'on': Enable waiting room - 'off': Disabled waiting room

totalActiveUsers^Required

public readonly totalActiveUsers: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property totalActiveUsers: The maximum number of active users.

waitingRoomName^Required

public readonly waitingRoomName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property waitingRoomName: The name of the waiting room.

waitingRoomType^Required

public readonly waitingRoomType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.

custom: indicates a custom type.

customPageHtml^Optional

public readonly customPageHtml: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.

The incoming content needs to be base64 encoded.

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Waiting room description.

disableSessionRenewalEnable^Optional

public readonly disableSessionRenewalEnable: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property disableSessionRenewalEnable: Specifies whether to disable session renewal.

Value: - on: open. - off: closed.

jsonResponseEnable^Optional

public readonly jsonResponseEnable: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property jsonResponseEnable: The JSON response.

If the accept request header contains "application\/json", JSON data is returned. Value: - on: open. - off: closed.

language^Optional

public readonly language: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property language: The language of the waiting room page.

When the waiting room type is the default type, it needs to be passed in. The following types are supported: - enus: English. - zhcn: Simplified Chinese. - zhhk: Traditional Chinese.

queueAllEnable^Optional

public readonly queueAllEnable: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property queueAllEnable: Specifies whether to queue all requests.

Value: - on: open. - off: closed.