pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/WaitingRoomArgs

WaitingRoomArgs

data class WaitingRoomArgs(val additionalRoutes: Output<List<WaitingRoomAdditionalRouteArgs>>? = null, val cookieSuffix: Output<String>? = null, val customPageHtml: Output<String>? = null, val defaultTemplateLanguage: Output<String>? = null, val description: Output<String>? = null, val disableSessionRenewal: Output<Boolean>? = null, val host: Output<String>? = null, val jsonResponseEnabled: Output<Boolean>? = null, val name: Output<String>? = null, val newUsersPerMinute: Output<Int>? = null, val path: Output<String>? = null, val queueAll: Output<Boolean>? = null, val queueingMethod: Output<String>? = null, val queueingStatusCode: Output<Int>? = null, val sessionDuration: Output<Int>? = null, val suspended: Output<Boolean>? = null, val totalActiveUsers: Output<Int>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<WaitingRoomArgs>

Provides a Cloudflare Waiting Room resource.

Example Usage

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) {
        var example = new WaitingRoom("example", WaitingRoomArgs.builder()
            .additionalRoutes(
                WaitingRoomAdditionalRouteArgs.builder()
                    .host("shop1.example.com")
                    .path("/example-path")
                    .build(),
                WaitingRoomAdditionalRouteArgs.builder()
                    .host("shop2.example.com")
                    .build())
            .cookieSuffix("queue1")
            .host("foo.example.com")
            .name("foo")
            .newUsersPerMinute(200)
            .path("/")
            .queueingStatusCode(200)
            .totalActiveUsers(200)
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .build());
    }
}

Import

Use the Zone ID and Waiting Room ID to import.

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

Constructors

WaitingRoomArgs

fun WaitingRoomArgs(additionalRoutes: Output<List<WaitingRoomAdditionalRouteArgs>>? = null, cookieSuffix: Output<String>? = null, customPageHtml: Output<String>? = null, defaultTemplateLanguage: Output<String>? = null, description: Output<String>? = null, disableSessionRenewal: Output<Boolean>? = null, host: Output<String>? = null, jsonResponseEnabled: Output<Boolean>? = null, name: Output<String>? = null, newUsersPerMinute: Output<Int>? = null, path: Output<String>? = null, queueAll: Output<Boolean>? = null, queueingMethod: Output<String>? = null, queueingStatusCode: Output<Int>? = null, sessionDuration: Output<Int>? = null, suspended: Output<Boolean>? = null, totalActiveUsers: Output<Int>? = null, zoneId: Output<String>? = null)

Functions

toJava

open override fun toJava(): WaitingRoomArgs

Properties

additionalRoutes

val additionalRoutes: Output<List<WaitingRoomAdditionalRouteArgs>>? = null

A list of additional hostname and paths combination to be applied on the waiting room.

cookieSuffix

val cookieSuffix: Output<String>? = null

A cookie suffix to be appended to the Cloudflare waiting room cookie name.

customPageHtml

val customPageHtml: Output<String>? = null

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

defaultTemplateLanguage

val defaultTemplateLanguage: Output<String>? = null

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. Defaults to en-US.

description

val description: Output<String>? = null

A description to add more details about the waiting room.

disableSessionRenewal

val disableSessionRenewal: Output<Boolean>? = null

Disables automatic renewal of session cookies.

host

val host: Output<String>? = null

The additional host name for which the waiting room to be applied on (no wildcards).

jsonResponseEnabled

val jsonResponseEnabled: Output<Boolean>? = null

If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object.

name

val name: Output<String>? = null

A unique name to identify the waiting room. Modifying this attribute will force creation of a new resource.

newUsersPerMinute

val newUsersPerMinute: Output<Int>? = null

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

path

val path: Output<String>? = null

The path within the additional host to enable the waiting room on. Defaults to /.

queueAll

val queueAll: Output<Boolean>? = null

If queue_all is true, then all traffic will be sent to the waiting room.

queueingMethod

val queueingMethod: Output<String>? = null

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

queueingStatusCode

val queueingStatusCode: Output<Int>? = null

HTTP status code returned to a user while in the queue. Defaults to 200.

sessionDuration

val sessionDuration: Output<Int>? = null

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

suspended

val suspended: Output<Boolean>? = null

Suspends the waiting room.

totalActiveUsers

val totalActiveUsers: Output<Int>? = null

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

zoneId

val zoneId: Output<String>? = null

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