WaitingRoom

• Implements: IWaitingRoom

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

Initializers

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

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cookie_name^Required

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

Property cookieName: The name of the custom cookie.

host_name_and_path^Required

• 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

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

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

queuing_method^Required

• 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

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

Unit: minutes.

site_id^Required

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

Property siteId: The site ID.

status^Required

• 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

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

Property totalActiveUsers: The maximum number of active users.

waiting_room_name^Required

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

Property waitingRoomName: The name of the waiting room.

waiting_room_type^Required

• 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

• 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: Specifies whether to disable session renewal.

Value:

• on: open.
• off: closed.

json_response_enable^Optional

• 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

• 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

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

Property queueAllEnable: Specifies whether to queue all requests.

Value:

• on: open.
• off: closed.

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.WaitingRoom.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_cookie_name^Required

attr_cookie_name: typing.Union[str, IResolvable]

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

Attribute CookieName: Custom Cookie name.

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

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

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

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_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_queue_all_enable^Required

attr_queue_all_enable: typing.Union[str, IResolvable]

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

Attribute QueueAllEnable: All in line.

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

attr_session_duration: typing.Union[str, IResolvable]

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

Attribute SessionDuration: Session duration in minutes.

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

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

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

attr_waiting_room_type: typing.Union[str, IResolvable]

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

Attribute WaitingRoomType: Waiting room type, support:.

props^Required

props: WaitingRoomProps

• Type: WaitingRoomProps