Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WaitingRoomEvent
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.WaitingRoomEvent

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    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,
    turnstileAction: "log",
    turnstileMode: "off",
});

    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,
    turnstile_action="log",
    turnstile_mode="off")

    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),
			TurnstileAction:       pulumi.String("log"),
			TurnstileMode:         pulumi.String("off"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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,
        TurnstileAction = "log",
        TurnstileMode = "off",
    });

});

    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)
            .turnstileAction("log")
            .turnstileMode("off")
            .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
      turnstileAction: log
      turnstileMode: off

    Create WaitingRoomEvent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WaitingRoomEvent(name: string, args: WaitingRoomEventArgs, opts?: CustomResourceOptions);
    @overload
def WaitingRoomEvent(resource_name: str,
                     args: WaitingRoomEventArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def WaitingRoomEvent(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     name: Optional[str] = None,
                     zone_id: Optional[str] = None,
                     waiting_room_id: Optional[str] = None,
                     event_end_time: Optional[str] = None,
                     event_start_time: Optional[str] = None,
                     queueing_method: Optional[str] = None,
                     new_users_per_minute: Optional[int] = None,
                     prequeue_start_time: Optional[str] = None,
                     custom_page_html: Optional[str] = None,
                     session_duration: Optional[int] = None,
                     shuffle_at_event_start: Optional[bool] = None,
                     suspended: Optional[bool] = None,
                     total_active_users: Optional[int] = None,
                     turnstile_action: Optional[str] = None,
                     turnstile_mode: Optional[str] = None,
                     disable_session_renewal: Optional[bool] = None,
                     description: Optional[str] = None)
    func NewWaitingRoomEvent(ctx *Context, name string, args WaitingRoomEventArgs, opts ...ResourceOption) (*WaitingRoomEvent, error)
    public WaitingRoomEvent(string name, WaitingRoomEventArgs args, CustomResourceOptions? opts = null)
    public WaitingRoomEvent(String name, WaitingRoomEventArgs args)
public WaitingRoomEvent(String name, WaitingRoomEventArgs args, CustomResourceOptions options)

    type: cloudflare:WaitingRoomEvent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var waitingRoomEventResource = new Cloudflare.WaitingRoomEvent("waitingRoomEventResource", new()
{
    Name = "string",
    ZoneId = "string",
    WaitingRoomId = "string",
    EventEndTime = "string",
    EventStartTime = "string",
    QueueingMethod = "string",
    NewUsersPerMinute = 0,
    PrequeueStartTime = "string",
    CustomPageHtml = "string",
    SessionDuration = 0,
    ShuffleAtEventStart = false,
    Suspended = false,
    TotalActiveUsers = 0,
    TurnstileAction = "string",
    TurnstileMode = "string",
    DisableSessionRenewal = false,
    Description = "string",
});

    example, err := cloudflare.NewWaitingRoomEvent(ctx, "waitingRoomEventResource", &cloudflare.WaitingRoomEventArgs{
	Name:                  pulumi.String("string"),
	ZoneId:                pulumi.String("string"),
	WaitingRoomId:         pulumi.String("string"),
	EventEndTime:          pulumi.String("string"),
	EventStartTime:        pulumi.String("string"),
	QueueingMethod:        pulumi.String("string"),
	NewUsersPerMinute:     pulumi.Int(0),
	PrequeueStartTime:     pulumi.String("string"),
	CustomPageHtml:        pulumi.String("string"),
	SessionDuration:       pulumi.Int(0),
	ShuffleAtEventStart:   pulumi.Bool(false),
	Suspended:             pulumi.Bool(false),
	TotalActiveUsers:      pulumi.Int(0),
	TurnstileAction:       pulumi.String("string"),
	TurnstileMode:         pulumi.String("string"),
	DisableSessionRenewal: pulumi.Bool(false),
	Description:           pulumi.String("string"),
})

    var waitingRoomEventResource = new WaitingRoomEvent("waitingRoomEventResource", WaitingRoomEventArgs.builder()
    .name("string")
    .zoneId("string")
    .waitingRoomId("string")
    .eventEndTime("string")
    .eventStartTime("string")
    .queueingMethod("string")
    .newUsersPerMinute(0)
    .prequeueStartTime("string")
    .customPageHtml("string")
    .sessionDuration(0)
    .shuffleAtEventStart(false)
    .suspended(false)
    .totalActiveUsers(0)
    .turnstileAction("string")
    .turnstileMode("string")
    .disableSessionRenewal(false)
    .description("string")
    .build());

    waiting_room_event_resource = cloudflare.WaitingRoomEvent("waitingRoomEventResource",
    name="string",
    zone_id="string",
    waiting_room_id="string",
    event_end_time="string",
    event_start_time="string",
    queueing_method="string",
    new_users_per_minute=0,
    prequeue_start_time="string",
    custom_page_html="string",
    session_duration=0,
    shuffle_at_event_start=False,
    suspended=False,
    total_active_users=0,
    turnstile_action="string",
    turnstile_mode="string",
    disable_session_renewal=False,
    description="string")

    const waitingRoomEventResource = new cloudflare.WaitingRoomEvent("waitingRoomEventResource", {
    name: "string",
    zoneId: "string",
    waitingRoomId: "string",
    eventEndTime: "string",
    eventStartTime: "string",
    queueingMethod: "string",
    newUsersPerMinute: 0,
    prequeueStartTime: "string",
    customPageHtml: "string",
    sessionDuration: 0,
    shuffleAtEventStart: false,
    suspended: false,
    totalActiveUsers: 0,
    turnstileAction: "string",
    turnstileMode: "string",
    disableSessionRenewal: false,
    description: "string",
});

    type: cloudflare:WaitingRoomEvent
properties:
    customPageHtml: string
    description: string
    disableSessionRenewal: false
    eventEndTime: string
    eventStartTime: string
    name: string
    newUsersPerMinute: 0
    prequeueStartTime: string
    queueingMethod: string
    sessionDuration: 0
    shuffleAtEventStart: false
    suspended: false
    totalActiveUsers: 0
    turnstileAction: string
    turnstileMode: string
    waitingRoomId: string
    zoneId: string

    WaitingRoomEvent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WaitingRoomEvent resource accepts the following input properties:

    EventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    EventStartTime string
    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.
    Name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    WaitingRoomId string
    ZoneId string
    Identifier
    CustomPageHtml string
    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.
    Description string
    A note that you can use to add more details about the event.
    DisableSessionRenewal bool
    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.
    NewUsersPerMinute int
    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.
    PrequeueStartTime string
    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.
    QueueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    SessionDuration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    ShuffleAtEventStart bool
    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.
    Suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    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.
    TurnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    TurnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    EventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    EventStartTime string
    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.
    Name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    WaitingRoomId string
    ZoneId string
    Identifier
    CustomPageHtml string
    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.
    Description string
    A note that you can use to add more details about the event.
    DisableSessionRenewal bool
    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.
    NewUsersPerMinute int
    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.
    PrequeueStartTime string
    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.
    QueueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    SessionDuration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    ShuffleAtEventStart bool
    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.
    Suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    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.
    TurnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    TurnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    eventEndTime String
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime String
    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.
    name String
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    waitingRoomId String
    zoneId String
    Identifier
    customPageHtml String
    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.
    description String
    A note that you can use to add more details about the event.
    disableSessionRenewal Boolean
    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.
    newUsersPerMinute Integer
    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.
    prequeueStartTime String
    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.
    queueingMethod String
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration Integer
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart Boolean
    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.
    suspended Boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Integer
    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.
    turnstileAction String
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode String
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    eventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime string
    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.
    name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    waitingRoomId string
    zoneId string
    Identifier
    customPageHtml string
    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.
    description string
    A note that you can use to add more details about the event.
    disableSessionRenewal boolean
    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.
    newUsersPerMinute number
    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.
    prequeueStartTime string
    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.
    queueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration number
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart boolean
    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.
    suspended boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers number
    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.
    turnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    event_end_time str
    An ISO 8601 timestamp that marks the end of the event.
    event_start_time str
    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.
    name str
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    waiting_room_id str
    zone_id str
    Identifier
    custom_page_html str
    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.
    description str
    A note that you can use to add more details about the event.
    disable_session_renewal bool
    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.
    new_users_per_minute int
    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.
    prequeue_start_time str
    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.
    queueing_method str
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    session_duration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffle_at_event_start bool
    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.
    suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    total_active_users int
    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.
    turnstile_action str
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstile_mode str
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    eventEndTime String
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime String
    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.
    name String
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    waitingRoomId String
    zoneId String
    Identifier
    customPageHtml String
    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.
    description String
    A note that you can use to add more details about the event.
    disableSessionRenewal Boolean
    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.
    newUsersPerMinute Number
    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.
    prequeueStartTime String
    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.
    queueingMethod String
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration Number
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart Boolean
    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.
    suspended Boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Number
    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.
    turnstileAction String
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode String
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WaitingRoomEvent resource produces the following output properties:

    CreatedOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    CreatedOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    createdOn String
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    createdOn string
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    created_on str
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    createdOn String
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String

    Look up Existing WaitingRoomEvent Resource

    Get an existing WaitingRoomEvent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WaitingRoomEventState, opts?: CustomResourceOptions): WaitingRoomEvent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_on: Optional[str] = None,
        custom_page_html: Optional[str] = None,
        description: Optional[str] = None,
        disable_session_renewal: Optional[bool] = None,
        event_end_time: Optional[str] = None,
        event_start_time: Optional[str] = None,
        modified_on: Optional[str] = None,
        name: Optional[str] = None,
        new_users_per_minute: Optional[int] = None,
        prequeue_start_time: Optional[str] = None,
        queueing_method: Optional[str] = None,
        session_duration: Optional[int] = None,
        shuffle_at_event_start: Optional[bool] = None,
        suspended: Optional[bool] = None,
        total_active_users: Optional[int] = None,
        turnstile_action: Optional[str] = None,
        turnstile_mode: Optional[str] = None,
        waiting_room_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> WaitingRoomEvent
    func GetWaitingRoomEvent(ctx *Context, name string, id IDInput, state *WaitingRoomEventState, opts ...ResourceOption) (*WaitingRoomEvent, error)
    public static WaitingRoomEvent Get(string name, Input<string> id, WaitingRoomEventState? state, CustomResourceOptions? opts = null)
    public static WaitingRoomEvent get(String name, Output<String> id, WaitingRoomEventState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:WaitingRoomEvent    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedOn string
    CustomPageHtml string
    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.
    Description string
    A note that you can use to add more details about the event.
    DisableSessionRenewal bool
    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.
    EventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    EventStartTime string
    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.
    ModifiedOn string
    Name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    NewUsersPerMinute int
    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.
    PrequeueStartTime string
    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.
    QueueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    SessionDuration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    ShuffleAtEventStart bool
    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.
    Suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    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.
    TurnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    TurnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    WaitingRoomId string
    ZoneId string
    Identifier
    CreatedOn string
    CustomPageHtml string
    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.
    Description string
    A note that you can use to add more details about the event.
    DisableSessionRenewal bool
    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.
    EventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    EventStartTime string
    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.
    ModifiedOn string
    Name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    NewUsersPerMinute int
    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.
    PrequeueStartTime string
    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.
    QueueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    SessionDuration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    ShuffleAtEventStart bool
    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.
    Suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    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.
    TurnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    TurnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    WaitingRoomId string
    ZoneId string
    Identifier
    createdOn String
    customPageHtml String
    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.
    description String
    A note that you can use to add more details about the event.
    disableSessionRenewal Boolean
    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.
    eventEndTime String
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime String
    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.
    modifiedOn String
    name String
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    newUsersPerMinute Integer
    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.
    prequeueStartTime String
    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.
    queueingMethod String
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration Integer
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart Boolean
    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.
    suspended Boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Integer
    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.
    turnstileAction String
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode String
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    waitingRoomId String
    zoneId String
    Identifier
    createdOn string
    customPageHtml string
    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.
    description string
    A note that you can use to add more details about the event.
    disableSessionRenewal boolean
    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.
    eventEndTime string
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime string
    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.
    modifiedOn string
    name string
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    newUsersPerMinute number
    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.
    prequeueStartTime string
    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.
    queueingMethod string
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration number
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart boolean
    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.
    suspended boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers number
    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.
    turnstileAction string
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode string
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    waitingRoomId string
    zoneId string
    Identifier
    created_on str
    custom_page_html str
    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.
    description str
    A note that you can use to add more details about the event.
    disable_session_renewal bool
    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.
    event_end_time str
    An ISO 8601 timestamp that marks the end of the event.
    event_start_time str
    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.
    modified_on str
    name str
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    new_users_per_minute int
    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.
    prequeue_start_time str
    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.
    queueing_method str
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    session_duration int
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffle_at_event_start bool
    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.
    suspended bool
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    total_active_users int
    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.
    turnstile_action str
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstile_mode str
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    waiting_room_id str
    zone_id str
    Identifier
    createdOn String
    customPageHtml String
    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.
    description String
    A note that you can use to add more details about the event.
    disableSessionRenewal Boolean
    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.
    eventEndTime String
    An ISO 8601 timestamp that marks the end of the event.
    eventStartTime String
    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.
    modifiedOn String
    name String
    A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
    newUsersPerMinute Number
    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.
    prequeueStartTime String
    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.
    queueingMethod String
    If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
    sessionDuration Number
    If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
    shuffleAtEventStart Boolean
    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.
    suspended Boolean
    Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Number
    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.
    turnstileAction String
    If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it. Available values: "log", "infinite_queue".
    turnstileMode String
    If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it. Available values: "off", "invisible", "visiblenoninteractive", "visible_managed".
    waitingRoomId String
    zoneId String
    Identifier

    Import

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare