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

cloudflare.getWaitingRoomEvents

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 exampleWaitingRoomEvents = cloudflare.getWaitingRoomEvents({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    waitingRoomId: "699d98642c564d2e855e9661899b7252",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_waiting_room_events = cloudflare.get_waiting_room_events(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    waiting_room_id="699d98642c564d2e855e9661899b7252")

    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.LookupWaitingRoomEvents(ctx, &cloudflare.LookupWaitingRoomEventsArgs{
			ZoneId:        "023e105f4ecef8ad9ca31a8372d0c353",
			WaitingRoomId: "699d98642c564d2e855e9661899b7252",
		}, nil)
		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 exampleWaitingRoomEvents = Cloudflare.GetWaitingRoomEvents.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        WaitingRoomId = "699d98642c564d2e855e9661899b7252",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetWaitingRoomEventsArgs;
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 exampleWaitingRoomEvents = CloudflareFunctions.getWaitingRoomEvents(GetWaitingRoomEventsArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .waitingRoomId("699d98642c564d2e855e9661899b7252")
            .build());

    }
}

    variables:
  exampleWaitingRoomEvents:
    fn::invoke:
      function: cloudflare:getWaitingRoomEvents
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        waitingRoomId: 699d98642c564d2e855e9661899b7252

    Using getWaitingRoomEvents

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWaitingRoomEvents(args: GetWaitingRoomEventsArgs, opts?: InvokeOptions): Promise<GetWaitingRoomEventsResult>
function getWaitingRoomEventsOutput(args: GetWaitingRoomEventsOutputArgs, opts?: InvokeOptions): Output<GetWaitingRoomEventsResult>
    def get_waiting_room_events(max_items: Optional[int] = None,
                            waiting_room_id: Optional[str] = None,
                            zone_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetWaitingRoomEventsResult
def get_waiting_room_events_output(max_items: Optional[pulumi.Input[int]] = None,
                            waiting_room_id: Optional[pulumi.Input[str]] = None,
                            zone_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetWaitingRoomEventsResult]
    func LookupWaitingRoomEvents(ctx *Context, args *LookupWaitingRoomEventsArgs, opts ...InvokeOption) (*LookupWaitingRoomEventsResult, error)
func LookupWaitingRoomEventsOutput(ctx *Context, args *LookupWaitingRoomEventsOutputArgs, opts ...InvokeOption) LookupWaitingRoomEventsResultOutput

    > Note: This function is named LookupWaitingRoomEvents in the Go SDK.

    public static class GetWaitingRoomEvents 
{
    public static Task<GetWaitingRoomEventsResult> InvokeAsync(GetWaitingRoomEventsArgs args, InvokeOptions? opts = null)
    public static Output<GetWaitingRoomEventsResult> Invoke(GetWaitingRoomEventsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWaitingRoomEventsResult> getWaitingRoomEvents(GetWaitingRoomEventsArgs args, InvokeOptions options)
public static Output<GetWaitingRoomEventsResult> getWaitingRoomEvents(GetWaitingRoomEventsArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getWaitingRoomEvents:getWaitingRoomEvents
  arguments:
    # arguments dictionary

    The following arguments are supported:

    WaitingRoomId string
    ZoneId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    WaitingRoomId string
    ZoneId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    waitingRoomId String
    zoneId String
    Identifier
    maxItems Integer
    Max items to fetch, default: 1000
    waitingRoomId string
    zoneId string
    Identifier
    maxItems number
    Max items to fetch, default: 1000
    waiting_room_id str
    zone_id str
    Identifier
    max_items int
    Max items to fetch, default: 1000
    waitingRoomId String
    zoneId String
    Identifier
    maxItems Number
    Max items to fetch, default: 1000

    getWaitingRoomEvents Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetWaitingRoomEventsResult>
    The items returned by the data source
    WaitingRoomId string
    ZoneId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetWaitingRoomEventsResult
    The items returned by the data source
    WaitingRoomId string
    ZoneId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetWaitingRoomEventsResult>
    The items returned by the data source
    waitingRoomId String
    zoneId String
    Identifier
    maxItems Integer
    Max items to fetch, default: 1000
    id string
    The provider-assigned unique ID for this managed resource.
    results GetWaitingRoomEventsResult[]
    The items returned by the data source
    waitingRoomId string
    zoneId string
    Identifier
    maxItems number
    Max items to fetch, default: 1000
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetWaitingRoomEventsResult]
    The items returned by the data source
    waiting_room_id str
    zone_id str
    Identifier
    max_items int
    Max items to fetch, default: 1000
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    waitingRoomId String
    zoneId String
    Identifier
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetWaitingRoomEventsResult

    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.
    Id string
    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".
    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.
    Id string
    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".
    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.
    id String
    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".
    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.
    id string
    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".
    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.
    id str
    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".
    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.
    id String
    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".

    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