WaitingRoomProps

Properties for defining a WaitingRoom.

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

Initializer

import ros_cdk_esa
ros_cdk_esa.WaitingRoomProps(
  cookie_name: typing.Union[str, IResolvable],
  host_name_and_path: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, HostNameAndPathProperty]]],
  new_users_per_minute: typing.Union[typing.Union[int, float], IResolvable],
  queuing_method: typing.Union[str, IResolvable],
  queuing_status_code: typing.Union[typing.Union[int, float], IResolvable],
  session_duration: typing.Union[typing.Union[int, float], IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  status: typing.Union[str, IResolvable],
  total_active_users: typing.Union[str, IResolvable],
  waiting_room_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,
  queue_all_enable: typing.Union[str, IResolvable] = None
)

Properties

cookie_name^Required

cookie_name: typing.Union[str, IResolvable]

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

Property cookieName: The name of the custom cookie.

host_name_and_path^Required

host_name_and_path: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, HostNameAndPathProperty]]]

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

Property hostNameAndPath: The hostname and path.

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: The maximum 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: 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.

queuing_status_code^Required

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

• Type: typing.Union[typing.Union[int, float], 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: The maximum duration for which a session remains valid after a user leaves the origin.

Unit: 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.

status^Required

status: typing.Union[str, IResolvable]

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

Property status: Waiting room enabled status.

Value:

• 'on': Enable waiting room
• 'off': Disabled waiting room

total_active_users^Required

total_active_users: typing.Union[str, IResolvable]

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

Property totalActiveUsers: The maximum number of active users.

waiting_room_name^Required

waiting_room_name: typing.Union[str, IResolvable]

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

Property waitingRoomName: The name of the waiting room.

waiting_room_type^Required

waiting_room_type: typing.Union[str, IResolvable]

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

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

• custom: indicates a 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: Specifies whether to 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: The JSON response.

If the accept request header contains "application/json", JSON data is returned. Value:

• on: open.
• off: closed.

language^Optional

language: typing.Union[str, IResolvable]

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

queue_all_enable^Optional

queue_all_enable: typing.Union[str, IResolvable]

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

Property queueAllEnable: Specifies whether to queue all requests.

Value:

• on: open.
• off: closed.