WaitingRoomEventArgs

data class WaitingRoomEventArgs(val customPageHtml: Output<String>? = null, val description: Output<String>? = null, val disableSessionRenewal: Output<Boolean>? = null, val eventEndTime: Output<String>? = null, val eventStartTime: Output<String>? = null, val name: Output<String>? = null, val newUsersPerMinute: Output<Int>? = null, val prequeueStartTime: Output<String>? = null, val queueingMethod: Output<String>? = null, val sessionDuration: Output<Int>? = null, val shuffleAtEventStart: Output<Boolean>? = null, val suspended: Output<Boolean>? = null, val totalActiveUsers: Output<Int>? = null, val waitingRoomId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<WaitingRoomEventArgs>

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleWaitingRoomEvent = new cloudflare.WaitingRoomEvent("example_waiting_room_event", {
zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
waitingRoomId: "699d98642c564d2e855e9661899b7252",
eventEndTime: "2021-09-28T17:00:00.000Z",
eventStartTime: "2021-09-28T15:30:00.000Z",
name: "production_webinar_event",
customPageHtml: "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
description: "Production event - DO NOT MODIFY",
disableSessionRenewal: true,
newUsersPerMinute: 200,
prequeueStartTime: "2021-09-28T15:00:00.000Z",
queueingMethod: "random",
sessionDuration: 1,
shuffleAtEventStart: true,
suspended: true,
totalActiveUsers: 200,
});
import pulumi
import pulumi_cloudflare as cloudflare
example_waiting_room_event = cloudflare.WaitingRoomEvent("example_waiting_room_event",
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
waiting_room_id="699d98642c564d2e855e9661899b7252",
event_end_time="2021-09-28T17:00:00.000Z",
event_start_time="2021-09-28T15:30:00.000Z",
name="production_webinar_event",
custom_page_html="{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
description="Production event - DO NOT MODIFY",
disable_session_renewal=True,
new_users_per_minute=200,
prequeue_start_time="2021-09-28T15:00:00.000Z",
queueing_method="random",
session_duration=1,
shuffle_at_event_start=True,
suspended=True,
total_active_users=200)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var exampleWaitingRoomEvent = new Cloudflare.WaitingRoomEvent("example_waiting_room_event", new()
{
ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
WaitingRoomId = "699d98642c564d2e855e9661899b7252",
EventEndTime = "2021-09-28T17:00:00.000Z",
EventStartTime = "2021-09-28T15:30:00.000Z",
Name = "production_webinar_event",
CustomPageHtml = "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
Description = "Production event - DO NOT MODIFY",
DisableSessionRenewal = true,
NewUsersPerMinute = 200,
PrequeueStartTime = "2021-09-28T15:00:00.000Z",
QueueingMethod = "random",
SessionDuration = 1,
ShuffleAtEventStart = true,
Suspended = true,
TotalActiveUsers = 200,
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewWaitingRoomEvent(ctx, "example_waiting_room_event", &cloudflare.WaitingRoomEventArgs{
ZoneId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
WaitingRoomId: pulumi.String("699d98642c564d2e855e9661899b7252"),
EventEndTime: pulumi.String("2021-09-28T17:00:00.000Z"),
EventStartTime: pulumi.String("2021-09-28T15:30:00.000Z"),
Name: pulumi.String("production_webinar_event"),
CustomPageHtml: pulumi.String("{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"),
Description: pulumi.String("Production event - DO NOT MODIFY"),
DisableSessionRenewal: pulumi.Bool(true),
NewUsersPerMinute: pulumi.Int(200),
PrequeueStartTime: pulumi.String("2021-09-28T15:00:00.000Z"),
QueueingMethod: pulumi.String("random"),
SessionDuration: pulumi.Int(1),
ShuffleAtEventStart: pulumi.Bool(true),
Suspended: pulumi.Bool(true),
TotalActiveUsers: pulumi.Int(200),
})
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.cloudflare.WaitingRoomEvent;
import com.pulumi.cloudflare.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) {
var exampleWaitingRoomEvent = new WaitingRoomEvent("exampleWaitingRoomEvent", WaitingRoomEventArgs.builder()
.zoneId("023e105f4ecef8ad9ca31a8372d0c353")
.waitingRoomId("699d98642c564d2e855e9661899b7252")
.eventEndTime("2021-09-28T17:00:00.000Z")
.eventStartTime("2021-09-28T15:30:00.000Z")
.name("production_webinar_event")
.customPageHtml("{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}")
.description("Production event - DO NOT MODIFY")
.disableSessionRenewal(true)
.newUsersPerMinute(200)
.prequeueStartTime("2021-09-28T15:00:00.000Z")
.queueingMethod("random")
.sessionDuration(1)
.shuffleAtEventStart(true)
.suspended(true)
.totalActiveUsers(200)
.build());
}
}
resources:
exampleWaitingRoomEvent:
type: cloudflare:WaitingRoomEvent
name: example_waiting_room_event
properties:
zoneId: 023e105f4ecef8ad9ca31a8372d0c353
waitingRoomId: 699d98642c564d2e855e9661899b7252
eventEndTime: 2021-09-28T17:00:00.000Z
eventStartTime: 2021-09-28T15:30:00.000Z
name: production_webinar_event
customPageHtml: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}'
description: Production event - DO NOT MODIFY
disableSessionRenewal: true
newUsersPerMinute: 200
prequeueStartTime: 2021-09-28T15:00:00.000Z
queueingMethod: random
sessionDuration: 1
shuffleAtEventStart: true
suspended: true
totalActiveUsers: 200

Import

$ pulumi import cloudflare:index/waitingRoomEvent:WaitingRoomEvent example '<zone_id>/<waiting_room_id>/<event_id>'

Constructors

Link copied to clipboard
constructor(customPageHtml: Output<String>? = null, description: Output<String>? = null, disableSessionRenewal: Output<Boolean>? = null, eventEndTime: Output<String>? = null, eventStartTime: Output<String>? = null, name: Output<String>? = null, newUsersPerMinute: Output<Int>? = null, prequeueStartTime: Output<String>? = null, queueingMethod: Output<String>? = null, sessionDuration: Output<Int>? = null, shuffleAtEventStart: Output<Boolean>? = null, suspended: Output<Boolean>? = null, totalActiveUsers: Output<Int>? = null, waitingRoomId: Output<String>? = null, zoneId: Output<String>? = null)

Properties

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

If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.

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

A note that you can use to add more details about the event.

Link copied to clipboard
val disableSessionRenewal: Output<Boolean>? = null

If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.

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

An ISO 8601 timestamp that marks the end of the event.

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

An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before event_end_time.

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

A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.

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

If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.

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

An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time.

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

If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.

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

If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.

Link copied to clipboard
val shuffleAtEventStart: Output<Boolean>? = null

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

Link copied to clipboard
val suspended: Output<Boolean>? = null

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

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

If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.

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

Identifier

Functions

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