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>

Provides a Cloudflare Waiting Room Event resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
// Waiting Room Event
const example = new cloudflare.WaitingRoomEvent("example", {
zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
waitingRoomId: "d41d8cd98f00b204e9800998ecf8427e",
name: "foo",
eventStartTime: "2006-01-02T15:04:05Z",
eventEndTime: "2006-01-02T20:04:05Z",
});
import pulumi
import pulumi_cloudflare as cloudflare
# Waiting Room Event
example = cloudflare.WaitingRoomEvent("example",
zone_id="0da42c8d2132a9ddaf714f9e7c920711",
waiting_room_id="d41d8cd98f00b204e9800998ecf8427e",
name="foo",
event_start_time="2006-01-02T15:04:05Z",
event_end_time="2006-01-02T20:04:05Z")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
// Waiting Room Event
var example = new Cloudflare.WaitingRoomEvent("example", new()
{
ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
WaitingRoomId = "d41d8cd98f00b204e9800998ecf8427e",
Name = "foo",
EventStartTime = "2006-01-02T15:04:05Z",
EventEndTime = "2006-01-02T20:04:05Z",
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Waiting Room Event
_, err := cloudflare.NewWaitingRoomEvent(ctx, "example", &cloudflare.WaitingRoomEventArgs{
ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
WaitingRoomId: pulumi.String("d41d8cd98f00b204e9800998ecf8427e"),
Name: pulumi.String("foo"),
EventStartTime: pulumi.String("2006-01-02T15:04:05Z"),
EventEndTime: pulumi.String("2006-01-02T20:04:05Z"),
})
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) {
// Waiting Room Event
var example = new WaitingRoomEvent("example", WaitingRoomEventArgs.builder()
.zoneId("0da42c8d2132a9ddaf714f9e7c920711")
.waitingRoomId("d41d8cd98f00b204e9800998ecf8427e")
.name("foo")
.eventStartTime("2006-01-02T15:04:05Z")
.eventEndTime("2006-01-02T20:04:05Z")
.build());
}
}
resources:
# Waiting Room Event
example:
type: cloudflare:WaitingRoomEvent
properties:
zoneId: 0da42c8d2132a9ddaf714f9e7c920711
waitingRoomId: d41d8cd98f00b204e9800998ecf8427e
name: foo
eventStartTime: 2006-01-02T15:04:05Z
eventEndTime: 2006-01-02T20:04:05Z

Import

Use the Zone ID, Waiting Room ID, and Event ID to import.

$ pulumi import cloudflare:index/waitingRoomEvent:WaitingRoomEvent default <zone_id>/<waiting_room_id>/<waiting_room_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

This is a templated html file that will be rendered at the edge.

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

A description to let users add more details about the event.

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

Disables automatic renewal of session cookies.

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

ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.

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

ISO 8601 timestamp that marks the start of the event. Must occur at least 1 minute before event_end_time. Modifying this attribute will force creation of a new resource.

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

A unique name to identify the event. Only alphanumeric characters, hyphens, and underscores are allowed. Modifying this attribute will force creation of a new resource.

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

The number of new users that will be let into the route every minute.

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

ISO 8601 timestamp that marks when to begin queueing all users before the event starts. Must occur at least 5 minutes before event_start_time.

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

The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.

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

Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.

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

Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.

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

If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.

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

The total number of active user sessions on the route at a point in time.

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

The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.

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

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

Functions

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