Skip to content

IWaitingRoom

Represents a WaitingRoom.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_cookie_name typing.Union[str, ros_cdk_core.IResolvable] Attribute CookieName: Custom Cookie name.
attr_custom_page_html typing.Union[str, ros_cdk_core.IResolvable] Attribute CustomPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: Waiting room description.
attr_disable_session_renewal_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute DisableSessionRenewalEnable: Disable session renewal.
attr_host_name_and_path typing.Union[str, ros_cdk_core.IResolvable] Attribute HostNameAndPath: Host name and path.
attr_json_response_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute JsonResponseEnable: The JSON response.
attr_language typing.Union[str, ros_cdk_core.IResolvable] Attribute Language: The language of the waiting room page.
attr_new_users_per_minute typing.Union[str, ros_cdk_core.IResolvable] Attribute NewUsersPerMinute: Number of new users per minute.
attr_queue_all_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute QueueAllEnable: All in line.
attr_queuing_method typing.Union[str, ros_cdk_core.IResolvable] Attribute QueuingMethod: Way of queuing.
attr_queuing_status_code typing.Union[str, ros_cdk_core.IResolvable] Attribute QueuingStatusCode: Waiting room status code.
attr_session_duration typing.Union[str, ros_cdk_core.IResolvable] Attribute SessionDuration: Session duration in minutes.
attr_total_active_users typing.Union[str, ros_cdk_core.IResolvable] Attribute TotalActiveUsers: Total number of active users.
attr_waiting_room_id typing.Union[str, ros_cdk_core.IResolvable] Attribute WaitingRoomId: The waiting room ID.
attr_waiting_room_name typing.Union[str, ros_cdk_core.IResolvable] Attribute WaitingRoomName: The name of the waiting room.
attr_waiting_room_type typing.Union[str, ros_cdk_core.IResolvable] Attribute WaitingRoomType: Waiting room type, support:.
props WaitingRoomProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


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

Attribute CookieName: Custom Cookie name.


attr_custom_page_htmlRequired

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

Attribute 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.


attr_descriptionRequired

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

Attribute Description: Waiting room description.


attr_disable_session_renewal_enableRequired

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

Attribute DisableSessionRenewalEnable: Disable session renewal.


attr_host_name_and_pathRequired

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

Attribute HostNameAndPath: Host name and path.


attr_json_response_enableRequired

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

Attribute JsonResponseEnable: The JSON response.

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


attr_languageRequired

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

Attribute Language: The language of the waiting room page.

When the waiting room type is the default type, it needs to be passed in.


attr_new_users_per_minuteRequired

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

Attribute NewUsersPerMinute: Number of new users per minute.


attr_queue_all_enableRequired

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

Attribute QueueAllEnable: All in line.


attr_queuing_methodRequired

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

Attribute QueuingMethod: Way of queuing.


attr_queuing_status_codeRequired

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

Attribute QueuingStatusCode: Waiting room status code.


attr_session_durationRequired

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

Attribute SessionDuration: Session duration in minutes.


attr_total_active_usersRequired

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

Attribute TotalActiveUsers: Total number of active users.


attr_waiting_room_idRequired

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

Attribute WaitingRoomId: The waiting room ID.


attr_waiting_room_nameRequired

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

Attribute WaitingRoomName: The name of the waiting room.


attr_waiting_room_typeRequired

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

Attribute WaitingRoomType: Waiting room type, support:.


propsRequired

props: WaitingRoomProps