Skip to content

WaitingRoomEvent

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

Initializers

import { WaitingRoomEvent } from '@alicloud/ros-cdk-esa'
new WaitingRoomEvent(scope: Construct, id: string, props: WaitingRoomEventProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props WaitingRoomEventProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { WaitingRoomEvent } from '@alicloud/ros-cdk-esa'
WaitingRoomEvent.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCustomPageHtml string | @alicloud/ros-cdk-core.IResolvable Attribute CustomPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: Waiting room description.
attrDisableSessionRenewalEnable string | @alicloud/ros-cdk-core.IResolvable Attribute DisableSessionRenewalEnable: Disable session renewal.
attrEndTime string | @alicloud/ros-cdk-core.IResolvable Attribute EndTime: The timestamp of the end time of the event.
attrJsonResponseEnable string | @alicloud/ros-cdk-core.IResolvable Attribute JsonResponseEnable: JSON response switch.
attrLanguage string | @alicloud/ros-cdk-core.IResolvable Attribute Language: Default language setting.
attrNewUsersPerMinute string | @alicloud/ros-cdk-core.IResolvable Attribute NewUsersPerMinute: Number of new users per minute.
attrPreQueueEnable string | @alicloud/ros-cdk-core.IResolvable Attribute PreQueueEnable: Pre-queue switch.
attrPreQueueStartTime string | @alicloud/ros-cdk-core.IResolvable Attribute PreQueueStartTime: Pre-queue start time.
attrQueuingMethod string | @alicloud/ros-cdk-core.IResolvable Attribute QueuingMethod: Way of queuing.
attrQueuingStatusCode string | @alicloud/ros-cdk-core.IResolvable Attribute QueuingStatusCode: Waiting room status code.
attrRandomPreQueueEnable string | @alicloud/ros-cdk-core.IResolvable Attribute RandomPreQueueEnable: Random queue switch.
attrSessionDuration string | @alicloud/ros-cdk-core.IResolvable Attribute SessionDuration: User session duration in minutes.
attrStartTime string | @alicloud/ros-cdk-core.IResolvable Attribute StartTime: The timestamp of the event start time.
attrTotalActiveUsers string | @alicloud/ros-cdk-core.IResolvable Attribute TotalActiveUsers: Total number of active users.
attrWaitingRoomEventId string | @alicloud/ros-cdk-core.IResolvable Attribute WaitingRoomEventId: The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
attrWaitingRoomEventName string | @alicloud/ros-cdk-core.IResolvable Attribute WaitingRoomEventName: Event name, custom event description.
attrWaitingRoomId string | @alicloud/ros-cdk-core.IResolvable Attribute WaitingRoomId: Waiting room ID, used to identify a specific waiting room.
attrWaitingRoomType string | @alicloud/ros-cdk-core.IResolvable Attribute WaitingRoomType: Waiting room type.
props WaitingRoomEventProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCustomPageHtmlRequired

public readonly attrCustomPageHtml: string | IResolvable;
  • Type: string | @alicloud/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.


attrDescriptionRequired

public readonly attrDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: Waiting room description.


attrDisableSessionRenewalEnableRequired

public readonly attrDisableSessionRenewalEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DisableSessionRenewalEnable: Disable session renewal.


attrEndTimeRequired

public readonly attrEndTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrJsonResponseEnableRequired

public readonly attrJsonResponseEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute JsonResponseEnable: JSON response switch.


attrLanguageRequired

public readonly attrLanguage: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Language: Default language setting.


attrNewUsersPerMinuteRequired

public readonly attrNewUsersPerMinute: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute NewUsersPerMinute: Number of new users per minute.


attrPreQueueEnableRequired

public readonly attrPreQueueEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PreQueueEnable: Pre-queue switch.


attrPreQueueStartTimeRequired

public readonly attrPreQueueStartTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PreQueueStartTime: Pre-queue start time.


attrQueuingMethodRequired

public readonly attrQueuingMethod: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute QueuingMethod: Way of queuing.


attrQueuingStatusCodeRequired

public readonly attrQueuingStatusCode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute QueuingStatusCode: Waiting room status code.


attrRandomPreQueueEnableRequired

public readonly attrRandomPreQueueEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute RandomPreQueueEnable: Random queue switch.


attrSessionDurationRequired

public readonly attrSessionDuration: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SessionDuration: User session duration in minutes.


attrStartTimeRequired

public readonly attrStartTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute StartTime: The timestamp of the event start time.


attrTotalActiveUsersRequired

public readonly attrTotalActiveUsers: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TotalActiveUsers: Total number of active users.


attrWaitingRoomEventIdRequired

public readonly attrWaitingRoomEventId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrWaitingRoomEventNameRequired

public readonly attrWaitingRoomEventName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WaitingRoomEventName: Event name, custom event description.


attrWaitingRoomIdRequired

public readonly attrWaitingRoomId: string | IResolvable;
  • Type: string | @alicloud/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.


attrWaitingRoomTypeRequired

public readonly attrWaitingRoomType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WaitingRoomType: Waiting room type.


propsRequired

public readonly props: WaitingRoomEventProps;