pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin.outputs/GetWaitingRoomsResult

GetWaitingRoomsResult

data class GetWaitingRoomsResult(val additionalRoutes: List<GetWaitingRoomsResultAdditionalRoute>, val cookieAttributes: GetWaitingRoomsResultCookieAttributes, val cookieSuffix: String, val createdOn: String, val customPageHtml: String, val defaultTemplateLanguage: String, val description: String, val disableSessionRenewal: Boolean, val enabledOriginCommands: List<String>, val host: String, val id: String, val jsonResponseEnabled: Boolean, val modifiedOn: String, val name: String, val newUsersPerMinute: Int, val nextEventPrequeueStartTime: String, val nextEventStartTime: String, val path: String, val queueAll: Boolean, val queueingMethod: String, val queueingStatusCode: Int, val sessionDuration: Int, val suspended: Boolean, val totalActiveUsers: Int, val turnstileAction: String, val turnstileMode: String)

Constructors

constructor(additionalRoutes: List<GetWaitingRoomsResultAdditionalRoute>, cookieAttributes: GetWaitingRoomsResultCookieAttributes, cookieSuffix: String, createdOn: String, customPageHtml: String, defaultTemplateLanguage: String, description: String, disableSessionRenewal: Boolean, enabledOriginCommands: List<String>, host: String, id: String, jsonResponseEnabled: Boolean, modifiedOn: String, name: String, newUsersPerMinute: Int, nextEventPrequeueStartTime: String, nextEventStartTime: String, path: String, queueAll: Boolean, queueingMethod: String, queueingStatusCode: Int, sessionDuration: Int, suspended: Boolean, totalActiveUsers: Int, turnstileAction: String, turnstileMode: String)

Types

Companion

object Companion

Properties

additionalRoutes

val additionalRoutes: List<GetWaitingRoomsResultAdditionalRoute>

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

val cookieAttributes: GetWaitingRoomsResultCookieAttributes

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

val 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

val createdOn: String

customPageHtml

val 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

val defaultTemplateLanguage: String

The language of the default page template. If no default_template_language is provided, then en-US (English) will be used. Available values: "en-US", "es-ES", "de-DE", "fr-FR", "it-IT", "ja-JP", "ko-KR", "pt-BR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "id-ID", "tr-TR", "ar-EG", "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".

description

val description: String

A note that you can use to add more details about the waiting room.

disableSessionRenewal

val disableSessionRenewal: Boolean

Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user's session cookie will be automatically renewed on every request.

enabledOriginCommands

val enabledOriginCommands: List<String>

A list of enabled origin commands.

host

val host: String

The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.

val id: String

jsonResponseEnabled

val jsonResponseEnabled: Boolean

Only available for the Waiting Room Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields:

modifiedOn

val modifiedOn: String

name

val name: String

A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.

newUsersPerMinute

val newUsersPerMinute: Int

Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.

nextEventPrequeueStartTime

val nextEventPrequeueStartTime: String

An ISO 8601 timestamp that marks when the next event will begin queueing.

nextEventStartTime

val nextEventStartTime: String

An ISO 8601 timestamp that marks when the next event will start.

path

val 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.

queueAll

val queueAll: Boolean

If queue_all is true, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.

queueingMethod

val queueingMethod: String

Sets the queueing method used by the waiting room. Changing this parameter from the default queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:

queueingStatusCode

val queueingStatusCode: Int

HTTP status code returned to a user while in the queue. Available values: 200, 202, 429.

sessionDuration

val sessionDuration: Int

Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.

suspended

val suspended: Boolean

Suspends or allows traffic going to the waiting room. If set to true, the traffic will not go to the waiting room.

totalActiveUsers

val totalActiveUsers: Int

Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.

turnstileAction

val turnstileAction: String

Which action to take when a bot is detected using Turnstile. log will have no impact on queueing behavior, simply keeping track of how many bots are detected in Waiting Room Analytics. infinite_queue will send bots to a false queueing state, where they will never reach your origin. infinite_queue requires Advanced Waiting Room. Available values: "log", "infinite_queue".

turnstileMode

val turnstileMode: String

Which Turnstile widget type to use for detecting bot traffic. See the Turnstile documentation for the definitions of these widget types. Set to off to disable the Turnstile integration entirely. Setting this to anything other than off or invisible requires Advanced Waiting Room. Available values: "off", "invisible", "visible_non_interactive", "visible_managed".