WaitingRoomEventProps

Properties for defining a WaitingRoomEvent.

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

Initializer

import ros_cdk_esa
ros_cdk_esa.WaitingRoomEventProps(
  end_time: typing.Union[str, IResolvable],
  new_users_per_minute: typing.Union[typing.Union[int, float], IResolvable],
  queuing_method: typing.Union[str, IResolvable],
  queuing_status_code: typing.Union[str, IResolvable],
  session_duration: typing.Union[typing.Union[int, float], IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  start_time: typing.Union[str, IResolvable],
  total_active_users: typing.Union[typing.Union[int, float], IResolvable],
  waiting_room_event_name: typing.Union[str, IResolvable],
  waiting_room_type: typing.Union[str, IResolvable],
  custom_page_html: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disable_session_renewal_enable: typing.Union[str, IResolvable] = None,
  json_response_enable: typing.Union[str, IResolvable] = None,
  language: typing.Union[str, IResolvable] = None,
  pre_queue_enable: typing.Union[str, IResolvable] = None,
  pre_queue_start_time: typing.Union[str, IResolvable] = None,
  random_pre_queue_enable: typing.Union[str, IResolvable] = None,
  waiting_room_id: typing.Union[str, IResolvable] = None
)

Properties

end_time^Required

end_time: typing.Union[str, IResolvable]

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

Property endTime: The timestamp of the end time of the event.

new_users_per_minute^Required

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

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

Property newUsersPerMinute: Number of new users per minute.

queuing_method^Required

queuing_method: typing.Union[str, IResolvable]

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

Property queuingMethod: Way of queuing.

Value:

• random: random.
• fifo: first in, first out.
• passthrough: through.
• reject-all: reject all.

queuing_status_code^Required

queuing_status_code: typing.Union[str, IResolvable]

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

Property queuingStatusCode: Waiting room status code.

Value:

• 200
• 202
• 429.

session_duration^Required

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

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

Property sessionDuration: User session duration in minutes.

site_id^Required

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

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

Property siteId: The site ID, which can be obtained by calling the ListSites API.

start_time^Required

start_time: typing.Union[str, IResolvable]

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

Property startTime: The timestamp of the event start time.

total_active_users^Required

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

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

Property totalActiveUsers: Total number of active users.

waiting_room_event_name^Required

waiting_room_event_name: typing.Union[str, IResolvable]

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

Property waitingRoomEventName: Event name, custom event description.

waiting_room_type^Required

waiting_room_type: typing.Union[str, IResolvable]

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

Property waitingRoomType: Waiting room type.

The following types are supported:

• default: the default type.
• custom: custom type.

custom_page_html^Optional

custom_page_html: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

description: typing.Union[str, IResolvable]

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

Property description: Waiting room description.

disable_session_renewal_enable^Optional

disable_session_renewal_enable: typing.Union[str, IResolvable]

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

Property disableSessionRenewalEnable: Disable session renewal.

Value:

• on: open.
• off: closed.

json_response_enable^Optional

json_response_enable: typing.Union[str, IResolvable]

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

Property jsonResponseEnable: JSON response switch.

Value:

• on: open.
• off: closed.

language^Optional

language: typing.Union[str, IResolvable]

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

Property language: Default language setting.

Values include:

• enus: English.
• zhcn: Simplified Chinese.
• zhhk: Traditional Chinese.

pre_queue_enable^Optional

pre_queue_enable: typing.Union[str, IResolvable]

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

Property preQueueEnable: Pre-queue switch.

• on: open.
• off: closed.

pre_queue_start_time^Optional

pre_queue_start_time: typing.Union[str, IResolvable]

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

Property preQueueStartTime: Pre-queue start time.

random_pre_queue_enable^Optional

random_pre_queue_enable: typing.Union[str, IResolvable]

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

Property randomPreQueueEnable: Random queue switch.

• on: open.
• off: closed.

waiting_room_id^Optional

waiting_room_id: typing.Union[str, IResolvable]

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

Property waitingRoomId: Waiting room ID, used to identify a specific waiting room.

It can be obtained by calling the listwaitingroom interface.