WaitingRoomEvent

• Implements: IWaitingRoomEvent

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

Initializers

import com.aliyun.ros.cdk.esa.WaitingRoomEvent;
WaitingRoomEvent.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .endTime(java.lang.String)
    .endTime(IResolvable)
    .newUsersPerMinute(java.lang.Number)
    .newUsersPerMinute(IResolvable)
    .queuingMethod(java.lang.String)
    .queuingMethod(IResolvable)
    .queuingStatusCode(java.lang.String)
    .queuingStatusCode(IResolvable)
    .sessionDuration(java.lang.Number)
    .sessionDuration(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
    .startTime(java.lang.String)
    .startTime(IResolvable)
    .totalActiveUsers(java.lang.Number)
    .totalActiveUsers(IResolvable)
    .waitingRoomEventName(java.lang.String)
    .waitingRoomEventName(IResolvable)
    .waitingRoomType(java.lang.String)
    .waitingRoomType(IResolvable)
//  .customPageHtml(java.lang.String)
//  .customPageHtml(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableSessionRenewalEnable(java.lang.String)
//  .disableSessionRenewalEnable(IResolvable)
//  .jsonResponseEnable(java.lang.String)
//  .jsonResponseEnable(IResolvable)
//  .language(java.lang.String)
//  .language(IResolvable)
//  .preQueueEnable(java.lang.String)
//  .preQueueEnable(IResolvable)
//  .preQueueStartTime(java.lang.String)
//  .preQueueStartTime(IResolvable)
//  .randomPreQueueEnable(java.lang.String)
//  .randomPreQueueEnable(IResolvable)
//  .waitingRoomId(java.lang.String)
//  .waitingRoomId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

endTime^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

newUsersPerMinute^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property newUsersPerMinute: Number of new users per minute.

queuingMethod^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queuingMethod: Way of queuing.

Value:

• random: random.
• fifo: first in, first out.
• passthrough: through.
• reject-all: reject all.

queuingStatusCode^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queuingStatusCode: Waiting room status code.

Value:

• 200
• 202
• 429.

sessionDuration^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property sessionDuration: User session duration in minutes.

siteId^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property siteId: The site ID, which can be obtained by calling the ListSites API.

startTime^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property startTime: The timestamp of the event start time.

totalActiveUsers^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property totalActiveUsers: Total number of active users.

waitingRoomEventName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomEventName: Event name, custom event description.

waitingRoomType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomType: Waiting room type.

The following types are supported:

• default: the default type.
• custom: custom type.

customPageHtml^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Waiting room description.

disableSessionRenewalEnable^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property disableSessionRenewalEnable: Disable session renewal.

Value:

• on: open.
• off: closed.

jsonResponseEnable^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property jsonResponseEnable: JSON response switch.

Value:

• on: open.
• off: closed.

language^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property language: Default language setting.

Values include:

• enus: English.
• zhcn: Simplified Chinese.
• zhhk: Traditional Chinese.

preQueueEnable^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property preQueueEnable: Pre-queue switch.

• on: open.
• off: closed.

preQueueStartTime^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property preQueueStartTime: Pre-queue start time.

randomPreQueueEnable^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property randomPreQueueEnable: Random queue switch.

• on: open.
• off: closed.

waitingRoomId^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.WaitingRoomEvent;
WaitingRoomEvent.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCustomPageHtml^Required

public java.lang.Object getAttrCustomPageHtml();

• Type: java.lang.String OR com.aliyun.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.

attrDescription^Required

public java.lang.Object getAttrDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: Waiting room description.

attrDisableSessionRenewalEnable^Required

public java.lang.Object getAttrDisableSessionRenewalEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DisableSessionRenewalEnable: Disable session renewal.

attrEndTime^Required

public java.lang.Object getAttrEndTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrJsonResponseEnable^Required

public java.lang.Object getAttrJsonResponseEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute JsonResponseEnable: JSON response switch.

attrLanguage^Required

public java.lang.Object getAttrLanguage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Language: Default language setting.

attrNewUsersPerMinute^Required

public java.lang.Object getAttrNewUsersPerMinute();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NewUsersPerMinute: Number of new users per minute.

attrPreQueueEnable^Required

public java.lang.Object getAttrPreQueueEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PreQueueEnable: Pre-queue switch.

attrPreQueueStartTime^Required

public java.lang.Object getAttrPreQueueStartTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PreQueueStartTime: Pre-queue start time.

attrQueuingMethod^Required

public java.lang.Object getAttrQueuingMethod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute QueuingMethod: Way of queuing.

attrQueuingStatusCode^Required

public java.lang.Object getAttrQueuingStatusCode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute QueuingStatusCode: Waiting room status code.

attrRandomPreQueueEnable^Required

public java.lang.Object getAttrRandomPreQueueEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RandomPreQueueEnable: Random queue switch.

attrSessionDuration^Required

public java.lang.Object getAttrSessionDuration();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SessionDuration: User session duration in minutes.

attrStartTime^Required

public java.lang.Object getAttrStartTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StartTime: The timestamp of the event start time.

attrTotalActiveUsers^Required

public java.lang.Object getAttrTotalActiveUsers();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TotalActiveUsers: Total number of active users.

attrWaitingRoomEventId^Required

public java.lang.Object getAttrWaitingRoomEventId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrWaitingRoomEventName^Required

public java.lang.Object getAttrWaitingRoomEventName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WaitingRoomEventName: Event name, custom event description.

attrWaitingRoomId^Required

public java.lang.Object getAttrWaitingRoomId();

• Type: java.lang.String OR com.aliyun.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.

attrWaitingRoomType^Required

public java.lang.Object getAttrWaitingRoomType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WaitingRoomType: Waiting room type.

props^Required

public WaitingRoomEventProps getProps();

• Type: WaitingRoomEventProps