WaitingRoom

• Implements: IWaitingRoom

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

Initializers

import com.aliyun.ros.cdk.esa.WaitingRoom;
WaitingRoom.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .cookieName(java.lang.String)
    .cookieName(IResolvable)
    .hostNameAndPath(IResolvable)
    .hostNameAndPath(java.util.List<IResolvable)
    .hostNameAndPath(HostNameAndPathProperty>)
    .newUsersPerMinute(java.lang.Number)
    .newUsersPerMinute(IResolvable)
    .queuingMethod(java.lang.String)
    .queuingMethod(IResolvable)
    .queuingStatusCode(java.lang.Number)
    .queuingStatusCode(IResolvable)
    .sessionDuration(java.lang.Number)
    .sessionDuration(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
    .status(java.lang.String)
    .status(IResolvable)
    .totalActiveUsers(java.lang.String)
    .totalActiveUsers(IResolvable)
    .waitingRoomName(java.lang.String)
    .waitingRoomName(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)
//  .queueAllEnable(java.lang.String)
//  .queueAllEnable(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

cookieName^Required

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

Property cookieName: The name of the custom cookie.

hostNameAndPath^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListHostNameAndPathProperty>

Property hostNameAndPath: The hostname and path.

newUsersPerMinute^Required

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

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

queuingMethod^Required

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

queuingStatusCode^Required

• Type: java.lang.Number 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: The maximum duration for which a session remains valid after a user leaves the origin.

Unit: minutes.

siteId^Required

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

Property siteId: The site ID.

status^Required

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

Property status: Waiting room enabled status.

Value:

• 'on': Enable waiting room
• 'off': Disabled waiting room

totalActiveUsers^Required

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

Property totalActiveUsers: The maximum number of active users.

waitingRoomName^Required

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

Property waitingRoomName: The name of the waiting room.

waitingRoomType^Required

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

Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.

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

Value:

• on: open.
• off: closed.

jsonResponseEnable^Optional

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

queueAllEnable^Optional

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

Property queueAllEnable: Specifies whether to queue all requests.

Value:

• on: open.
• off: closed.

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.WaitingRoom;
WaitingRoom.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

attrCookieName^Required

public java.lang.Object getAttrCookieName();

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

Attribute CookieName: Custom Cookie name.

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.

attrHostNameAndPath^Required

public java.lang.Object getAttrHostNameAndPath();

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

Attribute HostNameAndPath: Host name and path.

attrJsonResponseEnable^Required

public java.lang.Object getAttrJsonResponseEnable();

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

Attribute JsonResponseEnable: The JSON response.

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

attrLanguage^Required

public java.lang.Object getAttrLanguage();

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

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.

attrQueueAllEnable^Required

public java.lang.Object getAttrQueueAllEnable();

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

Attribute QueueAllEnable: All in line.

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.

attrSessionDuration^Required

public java.lang.Object getAttrSessionDuration();

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

Attribute SessionDuration: Session duration in minutes.

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.

attrWaitingRoomId^Required

public java.lang.Object getAttrWaitingRoomId();

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

Attribute WaitingRoomId: The waiting room ID.

attrWaitingRoomName^Required

public java.lang.Object getAttrWaitingRoomName();

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

Attribute WaitingRoomName: The name of the waiting room.

attrWaitingRoomType^Required

public java.lang.Object getAttrWaitingRoomType();

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

Attribute WaitingRoomType: Waiting room type, support:.

props^Required

public WaitingRoomProps getProps();

• Type: WaitingRoomProps