WaitingRoomEventArgs

data class WaitingRoomEventArgs(val customPageHtml: Output<String>? = null, val description: Output<String>? = null, val disableSessionRenewalEnable: Output<String>? = null, val endTime: Output<String>? = null, val jsonResponseEnable: Output<String>? = null, val language: Output<String>? = null, val newUsersPerMinute: Output<String>? = null, val preQueueEnable: Output<String>? = null, val preQueueStartTime: Output<String>? = null, val queuingMethod: Output<String>? = null, val queuingStatusCode: Output<String>? = null, val randomPreQueueEnable: Output<String>? = null, val sessionDuration: Output<String>? = null, val siteId: Output<Int>? = null, val startTime: Output<String>? = null, val status: Output<String>? = null, val totalActiveUsers: Output<String>? = null, val waitingRoomEventName: Output<String>? = null, val waitingRoomId: Output<String>? = null, val waitingRoomType: Output<String>? = null) : ConvertibleToJava<WaitingRoomEventArgs>

Provides a ESA Waiting Room Event resource. For information about ESA Waiting Room Event and how to use it, see What is Waiting Room Event.

NOTE: Available since v1.244.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const _default = alicloud.esa.getSites({
planSubscribeType: "enterpriseplan",
});
const defaultSite = new alicloud.esa.Site("default", {
siteName: "chenxin0116.site",
instanceId: _default.then(_default => _default.sites?.[0]?.instanceId),
coverage: "overseas",
accessType: "NS",
});
const defaultWaitingRoom = new alicloud.esa.WaitingRoom("default", {
status: "off",
siteId: defaultSite.id,
jsonResponseEnable: "off",
description: "example",
waitingRoomType: "default",
disableSessionRenewalEnable: "off",
cookieName: "__aliwaitingroom_example",
waitingRoomName: "waitingroom_example",
queueAllEnable: "off",
queuingStatusCode: "200",
customPageHtml: "",
newUsersPerMinute: "200",
sessionDuration: "5",
language: "zhcn",
totalActiveUsers: "300",
queuingMethod: "fifo",
hostNameAndPaths: [{
domain: "sub_domain.com",
path: "/example",
subdomain: "example_sub_domain.com.",
}],
});
const defaultWaitingRoomEvent = new alicloud.esa.WaitingRoomEvent("default", {
waitingRoomId: defaultWaitingRoom.waitingRoomId,
endTime: "1719863200",
waitingRoomEventName: "WaitingRoomEvent_example",
preQueueStartTime: "",
randomPreQueueEnable: "off",
jsonResponseEnable: "off",
siteId: defaultSite.id,
preQueueEnable: "off",
description: "example",
newUsersPerMinute: "200",
queuingStatusCode: "200",
customPageHtml: "",
language: "zhcn",
totalActiveUsers: "300",
waitingRoomType: "default",
startTime: "1719763200",
status: "off",
disableSessionRenewalEnable: "off",
queuingMethod: "fifo",
sessionDuration: "5",
});
import pulumi
import pulumi_alicloud as alicloud
default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
default_site = alicloud.esa.Site("default",
site_name="chenxin0116.site",
instance_id=default.sites[0].instance_id,
coverage="overseas",
access_type="NS")
default_waiting_room = alicloud.esa.WaitingRoom("default",
status="off",
site_id=default_site.id,
json_response_enable="off",
description="example",
waiting_room_type="default",
disable_session_renewal_enable="off",
cookie_name="__aliwaitingroom_example",
waiting_room_name="waitingroom_example",
queue_all_enable="off",
queuing_status_code="200",
custom_page_html="",
new_users_per_minute="200",
session_duration="5",
language="zhcn",
total_active_users="300",
queuing_method="fifo",
host_name_and_paths=[{
"domain": "sub_domain.com",
"path": "/example",
"subdomain": "example_sub_domain.com.",
}])
default_waiting_room_event = alicloud.esa.WaitingRoomEvent("default",
waiting_room_id=default_waiting_room.waiting_room_id,
end_time="1719863200",
waiting_room_event_name="WaitingRoomEvent_example",
pre_queue_start_time="",
random_pre_queue_enable="off",
json_response_enable="off",
site_id=default_site.id,
pre_queue_enable="off",
description="example",
new_users_per_minute="200",
queuing_status_code="200",
custom_page_html="",
language="zhcn",
total_active_users="300",
waiting_room_type="default",
start_time="1719763200",
status="off",
disable_session_renewal_enable="off",
queuing_method="fifo",
session_duration="5")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var @default = AliCloud.Esa.GetSites.Invoke(new()
{
PlanSubscribeType = "enterpriseplan",
});
var defaultSite = new AliCloud.Esa.Site("default", new()
{
SiteName = "chenxin0116.site",
InstanceId = @default.Apply(@default => @default.Apply(getSitesResult => getSitesResult.Sites[0]?.InstanceId)),
Coverage = "overseas",
AccessType = "NS",
});
var defaultWaitingRoom = new AliCloud.Esa.WaitingRoom("default", new()
{
Status = "off",
SiteId = defaultSite.Id,
JsonResponseEnable = "off",
Description = "example",
WaitingRoomType = "default",
DisableSessionRenewalEnable = "off",
CookieName = "__aliwaitingroom_example",
WaitingRoomName = "waitingroom_example",
QueueAllEnable = "off",
QueuingStatusCode = "200",
CustomPageHtml = "",
NewUsersPerMinute = "200",
SessionDuration = "5",
Language = "zhcn",
TotalActiveUsers = "300",
QueuingMethod = "fifo",
HostNameAndPaths = new[]
{
new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
{
Domain = "sub_domain.com",
Path = "/example",
Subdomain = "example_sub_domain.com.",
},
},
});
var defaultWaitingRoomEvent = new AliCloud.Esa.WaitingRoomEvent("default", new()
{
WaitingRoomId = defaultWaitingRoom.WaitingRoomId,
EndTime = "1719863200",
WaitingRoomEventName = "WaitingRoomEvent_example",
PreQueueStartTime = "",
RandomPreQueueEnable = "off",
JsonResponseEnable = "off",
SiteId = defaultSite.Id,
PreQueueEnable = "off",
Description = "example",
NewUsersPerMinute = "200",
QueuingStatusCode = "200",
CustomPageHtml = "",
Language = "zhcn",
TotalActiveUsers = "300",
WaitingRoomType = "default",
StartTime = "1719763200",
Status = "off",
DisableSessionRenewalEnable = "off",
QueuingMethod = "fifo",
SessionDuration = "5",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/esa"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := esa.GetSites(ctx, &esa.GetSitesArgs{
PlanSubscribeType: pulumi.StringRef("enterpriseplan"),
}, nil)
if err != nil {
return err
}
defaultSite, err := esa.NewSite(ctx, "default", &esa.SiteArgs{
SiteName: pulumi.String("chenxin0116.site"),
InstanceId: pulumi.String(_default.Sites[0].InstanceId),
Coverage: pulumi.String("overseas"),
AccessType: pulumi.String("NS"),
})
if err != nil {
return err
}
defaultWaitingRoom, err := esa.NewWaitingRoom(ctx, "default", &esa.WaitingRoomArgs{
Status: pulumi.String("off"),
SiteId: defaultSite.ID(),
JsonResponseEnable: pulumi.String("off"),
Description: pulumi.String("example"),
WaitingRoomType: pulumi.String("default"),
DisableSessionRenewalEnable: pulumi.String("off"),
CookieName: pulumi.String("__aliwaitingroom_example"),
WaitingRoomName: pulumi.String("waitingroom_example"),
QueueAllEnable: pulumi.String("off"),
QueuingStatusCode: pulumi.String("200"),
CustomPageHtml: pulumi.String(""),
NewUsersPerMinute: pulumi.String("200"),
SessionDuration: pulumi.String("5"),
Language: pulumi.String("zhcn"),
TotalActiveUsers: pulumi.String("300"),
QueuingMethod: pulumi.String("fifo"),
HostNameAndPaths: esa.WaitingRoomHostNameAndPathArray{
&esa.WaitingRoomHostNameAndPathArgs{
Domain: pulumi.String("sub_domain.com"),
Path: pulumi.String("/example"),
Subdomain: pulumi.String("example_sub_domain.com."),
},
},
})
if err != nil {
return err
}
_, err = esa.NewWaitingRoomEvent(ctx, "default", &esa.WaitingRoomEventArgs{
WaitingRoomId: defaultWaitingRoom.WaitingRoomId,
EndTime: pulumi.String("1719863200"),
WaitingRoomEventName: pulumi.String("WaitingRoomEvent_example"),
PreQueueStartTime: pulumi.String(""),
RandomPreQueueEnable: pulumi.String("off"),
JsonResponseEnable: pulumi.String("off"),
SiteId: defaultSite.ID(),
PreQueueEnable: pulumi.String("off"),
Description: pulumi.String("example"),
NewUsersPerMinute: pulumi.String("200"),
QueuingStatusCode: pulumi.String("200"),
CustomPageHtml: pulumi.String(""),
Language: pulumi.String("zhcn"),
TotalActiveUsers: pulumi.String("300"),
WaitingRoomType: pulumi.String("default"),
StartTime: pulumi.String("1719763200"),
Status: pulumi.String("off"),
DisableSessionRenewalEnable: pulumi.String("off"),
QueuingMethod: pulumi.String("fifo"),
SessionDuration: pulumi.String("5"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.esa.EsaFunctions;
import com.pulumi.alicloud.esa.inputs.GetSitesArgs;
import com.pulumi.alicloud.esa.Site;
import com.pulumi.alicloud.esa.SiteArgs;
import com.pulumi.alicloud.esa.WaitingRoom;
import com.pulumi.alicloud.esa.WaitingRoomArgs;
import com.pulumi.alicloud.esa.inputs.WaitingRoomHostNameAndPathArgs;
import com.pulumi.alicloud.esa.WaitingRoomEvent;
import com.pulumi.alicloud.esa.WaitingRoomEventArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var default = EsaFunctions.getSites(GetSitesArgs.builder()
.planSubscribeType("enterpriseplan")
.build());
var defaultSite = new Site("defaultSite", SiteArgs.builder()
.siteName("chenxin0116.site")
.instanceId(default_.sites()[0].instanceId())
.coverage("overseas")
.accessType("NS")
.build());
var defaultWaitingRoom = new WaitingRoom("defaultWaitingRoom", WaitingRoomArgs.builder()
.status("off")
.siteId(defaultSite.id())
.jsonResponseEnable("off")
.description("example")
.waitingRoomType("default")
.disableSessionRenewalEnable("off")
.cookieName("__aliwaitingroom_example")
.waitingRoomName("waitingroom_example")
.queueAllEnable("off")
.queuingStatusCode("200")
.customPageHtml("")
.newUsersPerMinute("200")
.sessionDuration("5")
.language("zhcn")
.totalActiveUsers("300")
.queuingMethod("fifo")
.hostNameAndPaths(WaitingRoomHostNameAndPathArgs.builder()
.domain("sub_domain.com")
.path("/example")
.subdomain("example_sub_domain.com.")
.build())
.build());
var defaultWaitingRoomEvent = new WaitingRoomEvent("defaultWaitingRoomEvent", WaitingRoomEventArgs.builder()
.waitingRoomId(defaultWaitingRoom.waitingRoomId())
.endTime("1719863200")
.waitingRoomEventName("WaitingRoomEvent_example")
.preQueueStartTime("")
.randomPreQueueEnable("off")
.jsonResponseEnable("off")
.siteId(defaultSite.id())
.preQueueEnable("off")
.description("example")
.newUsersPerMinute("200")
.queuingStatusCode("200")
.customPageHtml("")
.language("zhcn")
.totalActiveUsers("300")
.waitingRoomType("default")
.startTime("1719763200")
.status("off")
.disableSessionRenewalEnable("off")
.queuingMethod("fifo")
.sessionDuration("5")
.build());
}
}
resources:
defaultSite:
type: alicloud:esa:Site
name: default
properties:
siteName: chenxin0116.site
instanceId: ${default.sites[0].instanceId}
coverage: overseas
accessType: NS
defaultWaitingRoom:
type: alicloud:esa:WaitingRoom
name: default
properties:
status: off
siteId: ${defaultSite.id}
jsonResponseEnable: off
description: example
waitingRoomType: default
disableSessionRenewalEnable: off
cookieName: __aliwaitingroom_example
waitingRoomName: waitingroom_example
queueAllEnable: off
queuingStatusCode: '200'
customPageHtml: ""
newUsersPerMinute: '200'
sessionDuration: '5'
language: zhcn
totalActiveUsers: '300'
queuingMethod: fifo
hostNameAndPaths:
- domain: sub_domain.com
path: /example
subdomain: example_sub_domain.com.
defaultWaitingRoomEvent:
type: alicloud:esa:WaitingRoomEvent
name: default
properties:
waitingRoomId: ${defaultWaitingRoom.waitingRoomId}
endTime: '1719863200'
waitingRoomEventName: WaitingRoomEvent_example
preQueueStartTime: ""
randomPreQueueEnable: off
jsonResponseEnable: off
siteId: ${defaultSite.id}
preQueueEnable: off
description: example
newUsersPerMinute: '200'
queuingStatusCode: '200'
customPageHtml: ""
language: zhcn
totalActiveUsers: '300'
waitingRoomType: default
startTime: '1719763200'
status: off
disableSessionRenewalEnable: off
queuingMethod: fifo
sessionDuration: '5'
variables:
default:
fn::invoke:
function: alicloud:esa:getSites
arguments:
planSubscribeType: enterpriseplan

Import

ESA Waiting Room Event can be imported using the id, e.g.

$ pulumi import alicloud:esa/waitingRoomEvent:WaitingRoomEvent example <site_id>:<waiting_room_id>:<waiting_room_event_id>

Constructors

Link copied to clipboard
constructor(customPageHtml: Output<String>? = null, description: Output<String>? = null, disableSessionRenewalEnable: Output<String>? = null, endTime: Output<String>? = null, jsonResponseEnable: Output<String>? = null, language: Output<String>? = null, newUsersPerMinute: Output<String>? = null, preQueueEnable: Output<String>? = null, preQueueStartTime: Output<String>? = null, queuingMethod: Output<String>? = null, queuingStatusCode: Output<String>? = null, randomPreQueueEnable: Output<String>? = null, sessionDuration: Output<String>? = null, siteId: Output<Int>? = null, startTime: Output<String>? = null, status: Output<String>? = null, totalActiveUsers: Output<String>? = null, waitingRoomEventName: Output<String>? = null, waitingRoomId: Output<String>? = null, waitingRoomType: Output<String>? = null)

Properties

Link copied to clipboard
val customPageHtml: Output<String>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

Waiting room description.

Link copied to clipboard
val disableSessionRenewalEnable: Output<String>? = null

Disable session renewal. Value: -'on': open. -'off': closed.

Link copied to clipboard
val endTime: Output<String>? = null

The timestamp of the end time of the event.

Link copied to clipboard
val jsonResponseEnable: Output<String>? = null

JSON response switch. Value: -'on': open. -'off': closed.

Link copied to clipboard
val language: Output<String>? = null

Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.

Link copied to clipboard
val newUsersPerMinute: Output<String>? = null

Number of new users per minute.

Link copied to clipboard
val preQueueEnable: Output<String>? = null

Pre-queue switch. -'on': open. -'off': closed.

Link copied to clipboard
val preQueueStartTime: Output<String>? = null

Pre-queue start time.

Link copied to clipboard
val queuingMethod: Output<String>? = null

Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.

Link copied to clipboard
val queuingStatusCode: Output<String>? = null

Waiting room status code. Value: -'200' -'202' -'429'

Link copied to clipboard
val randomPreQueueEnable: Output<String>? = null

Random queue switch. -'on': open. -'off': closed.

Link copied to clipboard
val sessionDuration: Output<String>? = null

User session duration in minutes.

Link copied to clipboard
val siteId: Output<Int>? = null

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

Link copied to clipboard
val startTime: Output<String>? = null

The timestamp of the event start time.

Link copied to clipboard
val status: Output<String>? = null

Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events

Link copied to clipboard
val totalActiveUsers: Output<String>? = null

Total number of active users.

Link copied to clipboard
val waitingRoomEventName: Output<String>? = null

Event name, custom event description.

Link copied to clipboard
val waitingRoomId: Output<String>? = null

Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.

Link copied to clipboard
val waitingRoomType: Output<String>? = null

Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.

Functions

Link copied to clipboard
open override fun toJava(): WaitingRoomEventArgs