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

cloudflare.getWaitingRoom

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

    import pulumi
import pulumi_cloudflare as cloudflare

example_waiting_room = cloudflare.get_waiting_room(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.LookupWaitingRoom(ctx, &cloudflare.LookupWaitingRoomArgs{
			ZoneId:        "023e105f4ecef8ad9ca31a8372d0c353",
			WaitingRoomId: pulumi.StringRef("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 exampleWaitingRoom = Cloudflare.GetWaitingRoom.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.GetWaitingRoomArgs;
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 exampleWaitingRoom = CloudflareFunctions.getWaitingRoom(GetWaitingRoomArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .waitingRoomId("699d98642c564d2e855e9661899b7252")
            .build());

    }
}

    variables:
  exampleWaitingRoom:
    fn::invoke:
      function: cloudflare:getWaitingRoom
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        waitingRoomId: 699d98642c564d2e855e9661899b7252

    Using getWaitingRoom

    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 getWaitingRoom(args: GetWaitingRoomArgs, opts?: InvokeOptions): Promise<GetWaitingRoomResult>
function getWaitingRoomOutput(args: GetWaitingRoomOutputArgs, opts?: InvokeOptions): Output<GetWaitingRoomResult>
    def get_waiting_room(waiting_room_id: Optional[str] = None,
                     zone_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWaitingRoomResult
def get_waiting_room_output(waiting_room_id: Optional[pulumi.Input[str]] = None,
                     zone_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetWaitingRoomResult]
    func LookupWaitingRoom(ctx *Context, args *LookupWaitingRoomArgs, opts ...InvokeOption) (*LookupWaitingRoomResult, error)
func LookupWaitingRoomOutput(ctx *Context, args *LookupWaitingRoomOutputArgs, opts ...InvokeOption) LookupWaitingRoomResultOutput

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

    public static class GetWaitingRoom 
{
    public static Task<GetWaitingRoomResult> InvokeAsync(GetWaitingRoomArgs args, InvokeOptions? opts = null)
    public static Output<GetWaitingRoomResult> Invoke(GetWaitingRoomInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWaitingRoomResult> getWaitingRoom(GetWaitingRoomArgs args, InvokeOptions options)
public static Output<GetWaitingRoomResult> getWaitingRoom(GetWaitingRoomArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ZoneId string
    Identifier
    WaitingRoomId string
    ZoneId string
    Identifier
    WaitingRoomId string
    zoneId String
    Identifier
    waitingRoomId String
    zoneId string
    Identifier
    waitingRoomId string
    zone_id str
    Identifier
    waiting_room_id str
    zoneId String
    Identifier
    waitingRoomId String

    getWaitingRoom Result

    The following output properties are available:

    AdditionalRoutes List<GetWaitingRoomAdditionalRoute>
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    CookieAttributes GetWaitingRoomCookieAttributes
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    CookieSuffix string
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    CreatedOn string
    CustomPageHtml string
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    DefaultTemplateLanguage string
    Description string
    DisableSessionRenewal bool
    EnabledOriginCommands List<string>
    Host string
    Id string
    JsonResponseEnabled bool
    ModifiedOn string
    Name string
    NewUsersPerMinute int
    NextEventPrequeueStartTime string
    NextEventStartTime string
    Path string
    QueueAll bool
    QueueingMethod string
    QueueingStatusCode int
    SessionDuration int
    Suspended bool
    TotalActiveUsers int
    TurnstileAction string
    TurnstileMode string
    ZoneId string
    Identifier
    WaitingRoomId string
    AdditionalRoutes []GetWaitingRoomAdditionalRoute
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    CookieAttributes GetWaitingRoomCookieAttributes
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    CookieSuffix string
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    CreatedOn string
    CustomPageHtml string
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    DefaultTemplateLanguage string
    Description string
    DisableSessionRenewal bool
    EnabledOriginCommands []string
    Host string
    Id string
    JsonResponseEnabled bool
    ModifiedOn string
    Name string
    NewUsersPerMinute int
    NextEventPrequeueStartTime string
    NextEventStartTime string
    Path string
    QueueAll bool
    QueueingMethod string
    QueueingStatusCode int
    SessionDuration int
    Suspended bool
    TotalActiveUsers int
    TurnstileAction string
    TurnstileMode string
    ZoneId string
    Identifier
    WaitingRoomId string
    additionalRoutes List<GetWaitingRoomAdditionalRoute>
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    cookieAttributes GetWaitingRoomCookieAttributes
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    cookieSuffix String
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    createdOn String
    customPageHtml String
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    defaultTemplateLanguage String
    description String
    disableSessionRenewal Boolean
    enabledOriginCommands List<String>
    host String
    id String
    jsonResponseEnabled Boolean
    modifiedOn String
    name String
    newUsersPerMinute Integer
    nextEventPrequeueStartTime String
    nextEventStartTime String
    path String
    queueAll Boolean
    queueingMethod String
    queueingStatusCode Integer
    sessionDuration Integer
    suspended Boolean
    totalActiveUsers Integer
    turnstileAction String
    turnstileMode String
    zoneId String
    Identifier
    waitingRoomId String
    additionalRoutes GetWaitingRoomAdditionalRoute[]
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    cookieAttributes GetWaitingRoomCookieAttributes
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    cookieSuffix string
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    createdOn string
    customPageHtml string
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    defaultTemplateLanguage string
    description string
    disableSessionRenewal boolean
    enabledOriginCommands string[]
    host string
    id string
    jsonResponseEnabled boolean
    modifiedOn string
    name string
    newUsersPerMinute number
    nextEventPrequeueStartTime string
    nextEventStartTime string
    path string
    queueAll boolean
    queueingMethod string
    queueingStatusCode number
    sessionDuration number
    suspended boolean
    totalActiveUsers number
    turnstileAction string
    turnstileMode string
    zoneId string
    Identifier
    waitingRoomId string
    additional_routes Sequence[GetWaitingRoomAdditionalRoute]
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    cookie_attributes GetWaitingRoomCookieAttributes
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    cookie_suffix str
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    created_on str
    custom_page_html str
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    default_template_language str
    description str
    disable_session_renewal bool
    enabled_origin_commands Sequence[str]
    host str
    id str
    json_response_enabled bool
    modified_on str
    name str
    new_users_per_minute int
    next_event_prequeue_start_time str
    next_event_start_time str
    path str
    queue_all bool
    queueing_method str
    queueing_status_code int
    session_duration int
    suspended bool
    total_active_users int
    turnstile_action str
    turnstile_mode str
    zone_id str
    Identifier
    waiting_room_id str
    additionalRoutes List<Property Map>
    Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.
    cookieAttributes Property Map
    Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
    cookieSuffix String
    Appends a '' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(cfwaitingroom). If cookie_suffix is "abcd", the cookie name will be __cf_waitingroom_abcd. This field is required if using additional_routes.
    createdOn String
    customPageHtml String
    Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custompagehtml is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
    defaultTemplateLanguage String
    description String
    disableSessionRenewal Boolean
    enabledOriginCommands List<String>
    host String
    id String
    jsonResponseEnabled Boolean
    modifiedOn String
    name String
    newUsersPerMinute Number
    nextEventPrequeueStartTime String
    nextEventStartTime String
    path String
    queueAll Boolean
    queueingMethod String
    queueingStatusCode Number
    sessionDuration Number
    suspended Boolean
    totalActiveUsers Number
    turnstileAction String
    turnstileMode String
    zoneId String
    Identifier
    waitingRoomId String

    Supporting Types

    GetWaitingRoomAdditionalRoute

    Host string
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    Path string
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
    Host string
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    Path string
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
    host String
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    path String
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
    host string
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    path string
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
    host str
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    path str
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
    host String
    The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
    path String
    Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.

    GetWaitingRoomCookieAttributes

    Samesite string
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    Secure string
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".
    Samesite string
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    Secure string
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".
    samesite String
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    secure String
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".
    samesite string
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    secure string
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".
    samesite str
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    secure str
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".
    samesite String
    Configures the SameSite attribute on the waiting room cookie. Value auto will be translated to lax or none depending if Always Use HTTPS is enabled. Note that when using value none, the secure attribute cannot be set to never. Available values: "auto", "lax", "none", "strict".
    secure String
    Configures the Secure attribute on the waiting room cookie. Value always indicates that the Secure attribute will be set in the Set-Cookie header, never indicates that the Secure attribute will not be set, and auto will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "auto", "always", "never".

    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