WaitingRoomEvent

• Implements: IWaitingRoomEvent

This class encapsulates and extends the ROS resource type ALIYUN::ESA::WaitingRoomEvent.

Initializers

import ros_cdk_esa
ros_cdk_esa.WaitingRoomEvent(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

end_time^Required

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

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

new_users_per_minute^Required

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

Property newUsersPerMinute: Number of new users per minute.

queuing_method^Required

• 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

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

Property queuingStatusCode: Waiting room status code.

Value:

• 200
• 202
• 429.

session_duration^Required

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

Property sessionDuration: User session duration in minutes.

site_id^Required

• 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

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

Property startTime: The timestamp of the event start time.

total_active_users^Required

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

Property totalActiveUsers: Total number of active users.

waiting_room_event_name^Required

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

Property waitingRoomEventName: Event name, custom event description.

waiting_room_type^Required

• 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

• 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

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

Property description: Waiting room description.

disable_session_renewal_enable^Optional

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

Property disableSessionRenewalEnable: Disable session renewal.

Value:

• on: open.
• off: closed.

json_response_enable^Optional

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

Property jsonResponseEnable: JSON response switch.

Value:

• on: open.
• off: closed.

language^Optional

• 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

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

Property preQueueEnable: Pre-queue switch.

• on: open.
• off: closed.

pre_queue_start_time^Optional

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

Property preQueueStartTime: Pre-queue start time.

random_pre_queue_enable^Optional

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

Property randomPreQueueEnable: Random queue switch.

• on: open.
• off: closed.

waiting_room_id^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_esa
ros_cdk_esa.WaitingRoomEvent.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_custom_page_html^Required

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_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: Waiting room description.

attr_disable_session_renewal_enable^Required

attr_disable_session_renewal_enable: typing.Union[str, IResolvable]

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

Attribute DisableSessionRenewalEnable: Disable session renewal.

attr_end_time^Required

attr_end_time: typing.Union[str, IResolvable]

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

Attribute EndTime: The timestamp of the end time of the event.

attr_json_response_enable^Required

attr_json_response_enable: typing.Union[str, IResolvable]

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

Attribute JsonResponseEnable: JSON response switch.

attr_language^Required

attr_language: typing.Union[str, IResolvable]

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

Attribute Language: Default language setting.

attr_new_users_per_minute^Required

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_pre_queue_enable^Required

attr_pre_queue_enable: typing.Union[str, IResolvable]

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

Attribute PreQueueEnable: Pre-queue switch.

attr_pre_queue_start_time^Required

attr_pre_queue_start_time: typing.Union[str, IResolvable]

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

Attribute PreQueueStartTime: Pre-queue start time.

attr_queuing_method^Required

attr_queuing_method: typing.Union[str, IResolvable]

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

Attribute QueuingMethod: Way of queuing.

attr_queuing_status_code^Required

attr_queuing_status_code: typing.Union[str, IResolvable]

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

Attribute QueuingStatusCode: Waiting room status code.

attr_random_pre_queue_enable^Required

attr_random_pre_queue_enable: typing.Union[str, IResolvable]

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

Attribute RandomPreQueueEnable: Random queue switch.

attr_session_duration^Required

attr_session_duration: typing.Union[str, IResolvable]

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

Attribute SessionDuration: User session duration in minutes.

attr_start_time^Required

attr_start_time: typing.Union[str, IResolvable]

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

Attribute StartTime: The timestamp of the event start time.

attr_total_active_users^Required

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_event_id^Required

attr_waiting_room_event_id: typing.Union[str, IResolvable]

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

Attribute WaitingRoomEventId: The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.

attr_waiting_room_event_name^Required

attr_waiting_room_event_name: typing.Union[str, IResolvable]

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

Attribute WaitingRoomEventName: Event name, custom event description.

attr_waiting_room_id^Required

attr_waiting_room_id: typing.Union[str, IResolvable]

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

Attribute WaitingRoomId: Waiting room ID, used to identify a specific waiting room.

It can be obtained by calling the listwaitingroom interface.

attr_waiting_room_type^Required

attr_waiting_room_type: typing.Union[str, IResolvable]

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

Attribute WaitingRoomType: Waiting room type.

props^Required

props: WaitingRoomEventProps

• Type: WaitingRoomEventProps