WaitingRoom

• Implements: IWaitingRoom

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

Initializers

import { WaitingRoom } from '@alicloud/ros-cdk-esa'
new WaitingRoom(scope: Construct, id: string, props: WaitingRoomProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: WaitingRoomProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrCookieName^Required

public readonly attrCookieName: string | IResolvable;

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

Attribute CookieName: Custom Cookie name.

attrCustomPageHtml^Required

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.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

Attribute Description: Waiting room description.

attrDisableSessionRenewalEnable^Required

public readonly attrDisableSessionRenewalEnable: string | IResolvable;

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

Attribute DisableSessionRenewalEnable: Disable session renewal.

attrHostNameAndPath^Required

public readonly attrHostNameAndPath: string | IResolvable;

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

Attribute HostNameAndPath: Host name and path.

attrJsonResponseEnable^Required

public readonly attrJsonResponseEnable: string | IResolvable;

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

Attribute JsonResponseEnable: The JSON response.

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

attrLanguage^Required

public readonly attrLanguage: string | IResolvable;

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

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

Attribute NewUsersPerMinute: Number of new users per minute.

attrQueueAllEnable^Required

public readonly attrQueueAllEnable: string | IResolvable;

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

Attribute QueueAllEnable: All in line.

attrQueuingMethod^Required

public readonly attrQueuingMethod: string | IResolvable;

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

Attribute QueuingMethod: Way of queuing.

attrQueuingStatusCode^Required

public readonly attrQueuingStatusCode: string | IResolvable;

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

Attribute QueuingStatusCode: Waiting room status code.

attrSessionDuration^Required

public readonly attrSessionDuration: string | IResolvable;

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

Attribute SessionDuration: Session duration in minutes.

attrTotalActiveUsers^Required

public readonly attrTotalActiveUsers: string | IResolvable;

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

Attribute TotalActiveUsers: Total number of active users.

attrWaitingRoomId^Required

public readonly attrWaitingRoomId: string | IResolvable;

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

Attribute WaitingRoomId: The waiting room ID.

attrWaitingRoomName^Required

public readonly attrWaitingRoomName: string | IResolvable;

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

Attribute WaitingRoomName: The name of the waiting room.

attrWaitingRoomType^Required

public readonly attrWaitingRoomType: string | IResolvable;

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

Attribute WaitingRoomType: Waiting room type, support:.

props^Required

public readonly props: WaitingRoomProps;

• Type: WaitingRoomProps