Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WaitingRoom
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.WaitingRoom

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

Provides a Cloudflare Waiting Room resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

// Waiting Room
const example = new cloudflare.WaitingRoom("example", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    name: "foo",
    host: "foo.example.com",
    path: "/",
    newUsersPerMinute: 200,
    totalActiveUsers: 200,
    cookieSuffix: "queue1",
    additionalRoutes: [
        {
            host: "shop1.example.com",
            path: "/example-path",
        },
        {
            host: "shop2.example.com",
        },
    ],
    queueingStatusCode: 200,
    enabledOriginCommands: ["revoke"],
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

# Waiting Room
example = cloudflare.WaitingRoom("example",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    name="foo",
    host="foo.example.com",
    path="/",
    new_users_per_minute=200,
    total_active_users=200,
    cookie_suffix="queue1",
    additional_routes=[
        {
            "host": "shop1.example.com",
            "path": "/example-path",
        },
        {
            "host": "shop2.example.com",
        },
    ],
    queueing_status_code=200,
    enabled_origin_commands=["revoke"])
Copy
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Waiting Room
		_, err := cloudflare.NewWaitingRoom(ctx, "example", &cloudflare.WaitingRoomArgs{
			ZoneId:            pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Name:              pulumi.String("foo"),
			Host:              pulumi.String("foo.example.com"),
			Path:              pulumi.String("/"),
			NewUsersPerMinute: pulumi.Int(200),
			TotalActiveUsers:  pulumi.Int(200),
			CookieSuffix:      pulumi.String("queue1"),
			AdditionalRoutes: cloudflare.WaitingRoomAdditionalRouteArray{
				&cloudflare.WaitingRoomAdditionalRouteArgs{
					Host: pulumi.String("shop1.example.com"),
					Path: pulumi.String("/example-path"),
				},
				&cloudflare.WaitingRoomAdditionalRouteArgs{
					Host: pulumi.String("shop2.example.com"),
				},
			},
			QueueingStatusCode: pulumi.Int(200),
			EnabledOriginCommands: pulumi.StringArray{
				pulumi.String("revoke"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    // Waiting Room
    var example = new Cloudflare.WaitingRoom("example", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Name = "foo",
        Host = "foo.example.com",
        Path = "/",
        NewUsersPerMinute = 200,
        TotalActiveUsers = 200,
        CookieSuffix = "queue1",
        AdditionalRoutes = new[]
        {
            new Cloudflare.Inputs.WaitingRoomAdditionalRouteArgs
            {
                Host = "shop1.example.com",
                Path = "/example-path",
            },
            new Cloudflare.Inputs.WaitingRoomAdditionalRouteArgs
            {
                Host = "shop2.example.com",
            },
        },
        QueueingStatusCode = 200,
        EnabledOriginCommands = new[]
        {
            "revoke",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WaitingRoom;
import com.pulumi.cloudflare.WaitingRoomArgs;
import com.pulumi.cloudflare.inputs.WaitingRoomAdditionalRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Waiting Room
        var example = new WaitingRoom("example", WaitingRoomArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .name("foo")
            .host("foo.example.com")
            .path("/")
            .newUsersPerMinute(200)
            .totalActiveUsers(200)
            .cookieSuffix("queue1")
            .additionalRoutes(            
                WaitingRoomAdditionalRouteArgs.builder()
                    .host("shop1.example.com")
                    .path("/example-path")
                    .build(),
                WaitingRoomAdditionalRouteArgs.builder()
                    .host("shop2.example.com")
                    .build())
            .queueingStatusCode(200)
            .enabledOriginCommands("revoke")
            .build());

    }
}
Copy
resources:
  # Waiting Room
  example:
    type: cloudflare:WaitingRoom
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      name: foo
      host: foo.example.com
      path: /
      newUsersPerMinute: 200
      totalActiveUsers: 200
      cookieSuffix: queue1
      additionalRoutes:
        - host: shop1.example.com
          path: /example-path
        - host: shop2.example.com
      queueingStatusCode: 200
      enabledOriginCommands:
        - revoke
Copy

Create WaitingRoom Resource

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

Constructor syntax

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

@overload
def WaitingRoom(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                host: Optional[str] = None,
                zone_id: Optional[str] = None,
                total_active_users: Optional[int] = None,
                new_users_per_minute: Optional[int] = None,
                name: Optional[str] = None,
                json_response_enabled: Optional[bool] = None,
                queue_all: Optional[bool] = None,
                disable_session_renewal: Optional[bool] = None,
                additional_routes: Optional[Sequence[WaitingRoomAdditionalRouteArgs]] = None,
                description: Optional[str] = None,
                default_template_language: Optional[str] = None,
                path: Optional[str] = None,
                enabled_origin_commands: Optional[Sequence[str]] = None,
                queueing_method: Optional[str] = None,
                queueing_status_code: Optional[int] = None,
                session_duration: Optional[int] = None,
                suspended: Optional[bool] = None,
                custom_page_html: Optional[str] = None,
                cookie_suffix: Optional[str] = None)
func NewWaitingRoom(ctx *Context, name string, args WaitingRoomArgs, opts ...ResourceOption) (*WaitingRoom, error)
public WaitingRoom(string name, WaitingRoomArgs args, CustomResourceOptions? opts = null)
public WaitingRoom(String name, WaitingRoomArgs args)
public WaitingRoom(String name, WaitingRoomArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WaitingRoomArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WaitingRoomArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WaitingRoomArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WaitingRoomArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WaitingRoomArgs
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 waitingRoomResource = new Cloudflare.WaitingRoom("waitingRoomResource", new()
{
    Host = "string",
    ZoneId = "string",
    TotalActiveUsers = 0,
    NewUsersPerMinute = 0,
    Name = "string",
    JsonResponseEnabled = false,
    QueueAll = false,
    DisableSessionRenewal = false,
    AdditionalRoutes = new[]
    {
        new Cloudflare.Inputs.WaitingRoomAdditionalRouteArgs
        {
            Host = "string",
            Path = "string",
        },
    },
    Description = "string",
    DefaultTemplateLanguage = "string",
    Path = "string",
    EnabledOriginCommands = new[]
    {
        "string",
    },
    QueueingMethod = "string",
    QueueingStatusCode = 0,
    SessionDuration = 0,
    Suspended = false,
    CustomPageHtml = "string",
    CookieSuffix = "string",
});
Copy
example, err := cloudflare.NewWaitingRoom(ctx, "waitingRoomResource", &cloudflare.WaitingRoomArgs{
	Host:                  pulumi.String("string"),
	ZoneId:                pulumi.String("string"),
	TotalActiveUsers:      pulumi.Int(0),
	NewUsersPerMinute:     pulumi.Int(0),
	Name:                  pulumi.String("string"),
	JsonResponseEnabled:   pulumi.Bool(false),
	QueueAll:              pulumi.Bool(false),
	DisableSessionRenewal: pulumi.Bool(false),
	AdditionalRoutes: cloudflare.WaitingRoomAdditionalRouteArray{
		&cloudflare.WaitingRoomAdditionalRouteArgs{
			Host: pulumi.String("string"),
			Path: pulumi.String("string"),
		},
	},
	Description:             pulumi.String("string"),
	DefaultTemplateLanguage: pulumi.String("string"),
	Path:                    pulumi.String("string"),
	EnabledOriginCommands: pulumi.StringArray{
		pulumi.String("string"),
	},
	QueueingMethod:     pulumi.String("string"),
	QueueingStatusCode: pulumi.Int(0),
	SessionDuration:    pulumi.Int(0),
	Suspended:          pulumi.Bool(false),
	CustomPageHtml:     pulumi.String("string"),
	CookieSuffix:       pulumi.String("string"),
})
Copy
var waitingRoomResource = new WaitingRoom("waitingRoomResource", WaitingRoomArgs.builder()
    .host("string")
    .zoneId("string")
    .totalActiveUsers(0)
    .newUsersPerMinute(0)
    .name("string")
    .jsonResponseEnabled(false)
    .queueAll(false)
    .disableSessionRenewal(false)
    .additionalRoutes(WaitingRoomAdditionalRouteArgs.builder()
        .host("string")
        .path("string")
        .build())
    .description("string")
    .defaultTemplateLanguage("string")
    .path("string")
    .enabledOriginCommands("string")
    .queueingMethod("string")
    .queueingStatusCode(0)
    .sessionDuration(0)
    .suspended(false)
    .customPageHtml("string")
    .cookieSuffix("string")
    .build());
Copy
waiting_room_resource = cloudflare.WaitingRoom("waitingRoomResource",
    host="string",
    zone_id="string",
    total_active_users=0,
    new_users_per_minute=0,
    name="string",
    json_response_enabled=False,
    queue_all=False,
    disable_session_renewal=False,
    additional_routes=[{
        "host": "string",
        "path": "string",
    }],
    description="string",
    default_template_language="string",
    path="string",
    enabled_origin_commands=["string"],
    queueing_method="string",
    queueing_status_code=0,
    session_duration=0,
    suspended=False,
    custom_page_html="string",
    cookie_suffix="string")
Copy
const waitingRoomResource = new cloudflare.WaitingRoom("waitingRoomResource", {
    host: "string",
    zoneId: "string",
    totalActiveUsers: 0,
    newUsersPerMinute: 0,
    name: "string",
    jsonResponseEnabled: false,
    queueAll: false,
    disableSessionRenewal: false,
    additionalRoutes: [{
        host: "string",
        path: "string",
    }],
    description: "string",
    defaultTemplateLanguage: "string",
    path: "string",
    enabledOriginCommands: ["string"],
    queueingMethod: "string",
    queueingStatusCode: 0,
    sessionDuration: 0,
    suspended: false,
    customPageHtml: "string",
    cookieSuffix: "string",
});
Copy
type: cloudflare:WaitingRoom
properties:
    additionalRoutes:
        - host: string
          path: string
    cookieSuffix: string
    customPageHtml: string
    defaultTemplateLanguage: string
    description: string
    disableSessionRenewal: false
    enabledOriginCommands:
        - string
    host: string
    jsonResponseEnabled: false
    name: string
    newUsersPerMinute: 0
    path: string
    queueAll: false
    queueingMethod: string
    queueingStatusCode: 0
    sessionDuration: 0
    suspended: false
    totalActiveUsers: 0
    zoneId: string
Copy

WaitingRoom 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 WaitingRoom resource accepts the following input properties:

Host This property is required. string
Host name for which the waiting room will be applied (no wildcards).
Name
This property is required.
Changes to this property will trigger replacement.
string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
NewUsersPerMinute This property is required. int
The number of new users that will be let into the route every minute.
TotalActiveUsers This property is required. int
The total number of active user sessions on the route at a point in time.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
AdditionalRoutes List<WaitingRoomAdditionalRoute>
A list of additional hostname and paths combination to be applied on the waiting room.
CookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
CustomPageHtml string
This is a templated html file that will be rendered at the edge.
DefaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
Description string
A description to add more details about the waiting room.
DisableSessionRenewal bool
Disables automatic renewal of session cookies.
EnabledOriginCommands List<string>
The list of enabled origin commands for the waiting room. Available values: revoke.
JsonResponseEnabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
Path string
The path within the host to enable the waiting room on. Defaults to /.
QueueAll bool
If queue_all is true, then all traffic will be sent to the waiting room.
QueueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
QueueingStatusCode int
HTTP status code returned to a user while in the queue. Defaults to 200.
SessionDuration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
Suspended bool
Suspends the waiting room.
Host This property is required. string
Host name for which the waiting room will be applied (no wildcards).
Name
This property is required.
Changes to this property will trigger replacement.
string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
NewUsersPerMinute This property is required. int
The number of new users that will be let into the route every minute.
TotalActiveUsers This property is required. int
The total number of active user sessions on the route at a point in time.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
AdditionalRoutes []WaitingRoomAdditionalRouteArgs
A list of additional hostname and paths combination to be applied on the waiting room.
CookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
CustomPageHtml string
This is a templated html file that will be rendered at the edge.
DefaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
Description string
A description to add more details about the waiting room.
DisableSessionRenewal bool
Disables automatic renewal of session cookies.
EnabledOriginCommands []string
The list of enabled origin commands for the waiting room. Available values: revoke.
JsonResponseEnabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
Path string
The path within the host to enable the waiting room on. Defaults to /.
QueueAll bool
If queue_all is true, then all traffic will be sent to the waiting room.
QueueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
QueueingStatusCode int
HTTP status code returned to a user while in the queue. Defaults to 200.
SessionDuration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
Suspended bool
Suspends the waiting room.
host This property is required. String
Host name for which the waiting room will be applied (no wildcards).
name
This property is required.
Changes to this property will trigger replacement.
String
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute This property is required. Integer
The number of new users that will be let into the route every minute.
totalActiveUsers This property is required. Integer
The total number of active user sessions on the route at a point in time.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes List<WaitingRoomAdditionalRoute>
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix String
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml String
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage String
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description String
A description to add more details about the waiting room.
disableSessionRenewal Boolean
Disables automatic renewal of session cookies.
enabledOriginCommands List<String>
The list of enabled origin commands for the waiting room. Available values: revoke.
jsonResponseEnabled Boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
path String
The path within the host to enable the waiting room on. Defaults to /.
queueAll Boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod String
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode Integer
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration Integer
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended Boolean
Suspends the waiting room.
host This property is required. string
Host name for which the waiting room will be applied (no wildcards).
name
This property is required.
Changes to this property will trigger replacement.
string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute This property is required. number
The number of new users that will be let into the route every minute.
totalActiveUsers This property is required. number
The total number of active user sessions on the route at a point in time.
zoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes WaitingRoomAdditionalRoute[]
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml string
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description string
A description to add more details about the waiting room.
disableSessionRenewal boolean
Disables automatic renewal of session cookies.
enabledOriginCommands string[]
The list of enabled origin commands for the waiting room. Available values: revoke.
jsonResponseEnabled boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
path string
The path within the host to enable the waiting room on. Defaults to /.
queueAll boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode number
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration number
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended boolean
Suspends the waiting room.
host This property is required. str
Host name for which the waiting room will be applied (no wildcards).
name
This property is required.
Changes to this property will trigger replacement.
str
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
new_users_per_minute This property is required. int
The number of new users that will be let into the route every minute.
total_active_users This property is required. int
The total number of active user sessions on the route at a point in time.
zone_id
This property is required.
Changes to this property will trigger replacement.
str
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additional_routes Sequence[WaitingRoomAdditionalRouteArgs]
A list of additional hostname and paths combination to be applied on the waiting room.
cookie_suffix str
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
custom_page_html str
This is a templated html file that will be rendered at the edge.
default_template_language str
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description str
A description to add more details about the waiting room.
disable_session_renewal bool
Disables automatic renewal of session cookies.
enabled_origin_commands Sequence[str]
The list of enabled origin commands for the waiting room. Available values: revoke.
json_response_enabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
path str
The path within the host to enable the waiting room on. Defaults to /.
queue_all bool
If queue_all is true, then all traffic will be sent to the waiting room.
queueing_method str
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueing_status_code int
HTTP status code returned to a user while in the queue. Defaults to 200.
session_duration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended bool
Suspends the waiting room.
host This property is required. String
Host name for which the waiting room will be applied (no wildcards).
name
This property is required.
Changes to this property will trigger replacement.
String
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute This property is required. Number
The number of new users that will be let into the route every minute.
totalActiveUsers This property is required. Number
The total number of active user sessions on the route at a point in time.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes List<Property Map>
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix String
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml String
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage String
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description String
A description to add more details about the waiting room.
disableSessionRenewal Boolean
Disables automatic renewal of session cookies.
enabledOriginCommands List<String>
The list of enabled origin commands for the waiting room. Available values: revoke.
jsonResponseEnabled Boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
path String
The path within the host to enable the waiting room on. Defaults to /.
queueAll Boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod String
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode Number
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration Number
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended Boolean
Suspends the waiting room.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing WaitingRoom Resource

Get an existing WaitingRoom 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?: WaitingRoomState, opts?: CustomResourceOptions): WaitingRoom
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_routes: Optional[Sequence[WaitingRoomAdditionalRouteArgs]] = None,
        cookie_suffix: Optional[str] = None,
        custom_page_html: Optional[str] = None,
        default_template_language: Optional[str] = None,
        description: Optional[str] = None,
        disable_session_renewal: Optional[bool] = None,
        enabled_origin_commands: Optional[Sequence[str]] = None,
        host: Optional[str] = None,
        json_response_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        new_users_per_minute: Optional[int] = None,
        path: Optional[str] = None,
        queue_all: Optional[bool] = None,
        queueing_method: Optional[str] = None,
        queueing_status_code: Optional[int] = None,
        session_duration: Optional[int] = None,
        suspended: Optional[bool] = None,
        total_active_users: Optional[int] = None,
        zone_id: Optional[str] = None) -> WaitingRoom
func GetWaitingRoom(ctx *Context, name string, id IDInput, state *WaitingRoomState, opts ...ResourceOption) (*WaitingRoom, error)
public static WaitingRoom Get(string name, Input<string> id, WaitingRoomState? state, CustomResourceOptions? opts = null)
public static WaitingRoom get(String name, Output<String> id, WaitingRoomState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:WaitingRoom    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdditionalRoutes List<WaitingRoomAdditionalRoute>
A list of additional hostname and paths combination to be applied on the waiting room.
CookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
CustomPageHtml string
This is a templated html file that will be rendered at the edge.
DefaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
Description string
A description to add more details about the waiting room.
DisableSessionRenewal bool
Disables automatic renewal of session cookies.
EnabledOriginCommands List<string>
The list of enabled origin commands for the waiting room. Available values: revoke.
Host string
Host name for which the waiting room will be applied (no wildcards).
JsonResponseEnabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
Name Changes to this property will trigger replacement. string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
NewUsersPerMinute int
The number of new users that will be let into the route every minute.
Path string
The path within the host to enable the waiting room on. Defaults to /.
QueueAll bool
If queue_all is true, then all traffic will be sent to the waiting room.
QueueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
QueueingStatusCode int
HTTP status code returned to a user while in the queue. Defaults to 200.
SessionDuration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
Suspended bool
Suspends the waiting room.
TotalActiveUsers int
The total number of active user sessions on the route at a point in time.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
AdditionalRoutes []WaitingRoomAdditionalRouteArgs
A list of additional hostname and paths combination to be applied on the waiting room.
CookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
CustomPageHtml string
This is a templated html file that will be rendered at the edge.
DefaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
Description string
A description to add more details about the waiting room.
DisableSessionRenewal bool
Disables automatic renewal of session cookies.
EnabledOriginCommands []string
The list of enabled origin commands for the waiting room. Available values: revoke.
Host string
Host name for which the waiting room will be applied (no wildcards).
JsonResponseEnabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
Name Changes to this property will trigger replacement. string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
NewUsersPerMinute int
The number of new users that will be let into the route every minute.
Path string
The path within the host to enable the waiting room on. Defaults to /.
QueueAll bool
If queue_all is true, then all traffic will be sent to the waiting room.
QueueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
QueueingStatusCode int
HTTP status code returned to a user while in the queue. Defaults to 200.
SessionDuration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
Suspended bool
Suspends the waiting room.
TotalActiveUsers int
The total number of active user sessions on the route at a point in time.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes List<WaitingRoomAdditionalRoute>
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix String
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml String
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage String
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description String
A description to add more details about the waiting room.
disableSessionRenewal Boolean
Disables automatic renewal of session cookies.
enabledOriginCommands List<String>
The list of enabled origin commands for the waiting room. Available values: revoke.
host String
Host name for which the waiting room will be applied (no wildcards).
jsonResponseEnabled Boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
name Changes to this property will trigger replacement. String
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute Integer
The number of new users that will be let into the route every minute.
path String
The path within the host to enable the waiting room on. Defaults to /.
queueAll Boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod String
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode Integer
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration Integer
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended Boolean
Suspends the waiting room.
totalActiveUsers Integer
The total number of active user sessions on the route at a point in time.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes WaitingRoomAdditionalRoute[]
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix string
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml string
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage string
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description string
A description to add more details about the waiting room.
disableSessionRenewal boolean
Disables automatic renewal of session cookies.
enabledOriginCommands string[]
The list of enabled origin commands for the waiting room. Available values: revoke.
host string
Host name for which the waiting room will be applied (no wildcards).
jsonResponseEnabled boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
name Changes to this property will trigger replacement. string
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute number
The number of new users that will be let into the route every minute.
path string
The path within the host to enable the waiting room on. Defaults to /.
queueAll boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod string
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode number
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration number
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended boolean
Suspends the waiting room.
totalActiveUsers number
The total number of active user sessions on the route at a point in time.
zoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additional_routes Sequence[WaitingRoomAdditionalRouteArgs]
A list of additional hostname and paths combination to be applied on the waiting room.
cookie_suffix str
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
custom_page_html str
This is a templated html file that will be rendered at the edge.
default_template_language str
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description str
A description to add more details about the waiting room.
disable_session_renewal bool
Disables automatic renewal of session cookies.
enabled_origin_commands Sequence[str]
The list of enabled origin commands for the waiting room. Available values: revoke.
host str
Host name for which the waiting room will be applied (no wildcards).
json_response_enabled bool
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
name Changes to this property will trigger replacement. str
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
new_users_per_minute int
The number of new users that will be let into the route every minute.
path str
The path within the host to enable the waiting room on. Defaults to /.
queue_all bool
If queue_all is true, then all traffic will be sent to the waiting room.
queueing_method str
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueing_status_code int
HTTP status code returned to a user while in the queue. Defaults to 200.
session_duration int
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended bool
Suspends the waiting room.
total_active_users int
The total number of active user sessions on the route at a point in time.
zone_id Changes to this property will trigger replacement. str
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
additionalRoutes List<Property Map>
A list of additional hostname and paths combination to be applied on the waiting room.
cookieSuffix String
A cookie suffix to be appended to the Cloudflare waiting room cookie name.
customPageHtml String
This is a templated html file that will be rendered at the edge.
defaultTemplateLanguage String
The language to use for the default waiting room page. Available values: de-DE, es-ES, en-US, fr-FR, id-ID, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, tr-TR, zh-CN, zh-TW, ru-RU, fa-IR, bg-BG, hr-HR, cs-CZ, da-DK, fi-FI, lt-LT, ms-MY, nb-NO, ro-RO, el-GR, he-IL, hi-IN, hu-HU, sr-BA, sk-SK, sl-SI, sv-SE, tl-PH, th-TH, uk-UA, vi-VN. Defaults to en-US.
description String
A description to add more details about the waiting room.
disableSessionRenewal Boolean
Disables automatic renewal of session cookies.
enabledOriginCommands List<String>
The list of enabled origin commands for the waiting room. Available values: revoke.
host String
Host name for which the waiting room will be applied (no wildcards).
jsonResponseEnabled Boolean
If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.
name Changes to this property will trigger replacement. String
A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.
newUsersPerMinute Number
The number of new users that will be let into the route every minute.
path String
The path within the host to enable the waiting room on. Defaults to /.
queueAll Boolean
If queue_all is true, then all traffic will be sent to the waiting room.
queueingMethod String
The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject. Defaults to fifo.
queueingStatusCode Number
HTTP status code returned to a user while in the queue. Defaults to 200.
sessionDuration Number
Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin. Defaults to 5.
suspended Boolean
Suspends the waiting room.
totalActiveUsers Number
The total number of active user sessions on the route at a point in time.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

Supporting Types

WaitingRoomAdditionalRoute
, WaitingRoomAdditionalRouteArgs

Host This property is required. string
The additional host name for which the waiting room to be applied on (no wildcards).
Path string
The path within the additional host to enable the waiting room on. Defaults to /.
Host This property is required. string
The additional host name for which the waiting room to be applied on (no wildcards).
Path string
The path within the additional host to enable the waiting room on. Defaults to /.
host This property is required. String
The additional host name for which the waiting room to be applied on (no wildcards).
path String
The path within the additional host to enable the waiting room on. Defaults to /.
host This property is required. string
The additional host name for which the waiting room to be applied on (no wildcards).
path string
The path within the additional host to enable the waiting room on. Defaults to /.
host This property is required. str
The additional host name for which the waiting room to be applied on (no wildcards).
path str
The path within the additional host to enable the waiting room on. Defaults to /.
host This property is required. String
The additional host name for which the waiting room to be applied on (no wildcards).
path String
The path within the additional host to enable the waiting room on. Defaults to /.

Import

Use the Zone ID and Waiting Room ID to import.

$ pulumi import cloudflare:index/waitingRoom:WaitingRoom default <zone_id>/<waiting_room_id>
Copy

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 v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare