Docs Home
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva
incapsula.WaitingRoom
Explore with Pulumi AI
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva
Provides a waiting room resource. A waiting room controls the traffic to the website during peak periods when the origin server is unable to handle the load, and routes the website visitors to a virtual waiting room when their requests can’t be handled immediately. For full feature documentation, see Set Up a Waiting Room.
Note: At least one of the threshold strategies (entrance_rate_threshold / concurrent_sessions_threshold) must be configured.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fs from "fs";
import * as incapsula from "@pulumi/incapsula";
const example_waiting_room = new incapsula.WaitingRoom("example-waiting-room", {
siteId: incapsula_site["example-site"].id,
description: "Waiting room description",
enabled: true,
htmlTemplateBase64: fs.readFileSync("path/to/your/template.html", { encoding: "base64" }),
filter: " URL == \"/example\"\n",
botsActionInQueuingMode: "WAIT_IN_LINE",
entranceRateThreshold: 600,
concurrentSessionsThreshold: 600,
inactivityTimeout: 30,
queueInactivityTimeout: 1,
});
import pulumi
import base64
import pulumi_incapsula as incapsula
example_waiting_room = incapsula.WaitingRoom("example-waiting-room",
site_id=incapsula_site["example-site"]["id"],
description="Waiting room description",
enabled=True,
html_template_base64=(lambda path: base64.b64encode(open(path).read().encode()).decode())("path/to/your/template.html"),
filter=" URL == \"/example\"\n",
bots_action_in_queuing_mode="WAIT_IN_LINE",
entrance_rate_threshold=600,
concurrent_sessions_threshold=600,
inactivity_timeout=30,
queue_inactivity_timeout=1)
package main
import (
"encoding/base64"
"os"
"github.com/pulumi/pulumi-terraform-provider/sdks/go/incapsula/v3/incapsula"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func filebase64OrPanic(path string) string {
if fileData, err := os.ReadFile(path); err == nil {
return base64.StdEncoding.EncodeToString(fileData[:])
} else {
panic(err.Error())
}
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := incapsula.NewWaitingRoom(ctx, "example-waiting-room", &incapsula.WaitingRoomArgs{
SiteId: pulumi.Any(incapsula_site.ExampleSite.Id),
Description: pulumi.String("Waiting room description"),
Enabled: pulumi.Bool(true),
HtmlTemplateBase64: pulumi.String(filebase64OrPanic("path/to/your/template.html")),
Filter: pulumi.String(" URL == \"/example\"\n"),
BotsActionInQueuingMode: pulumi.String("WAIT_IN_LINE"),
EntranceRateThreshold: pulumi.Float64(600),
ConcurrentSessionsThreshold: pulumi.Float64(600),
InactivityTimeout: pulumi.Float64(30),
QueueInactivityTimeout: pulumi.Float64(1),
})
if err != nil {
return err
}
return nil
})
}
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Incapsula = Pulumi.Incapsula;
string ReadFileBase64(string path)
{
return Convert.ToBase64String(Encoding.UTF8.GetBytes(File.ReadAllText(path)));
}
return await Deployment.RunAsync(() =>
{
var example_waiting_room = new Incapsula.WaitingRoom("example-waiting-room", new()
{
SiteId = incapsula_site.Example_site.Id,
Description = "Waiting room description",
Enabled = true,
HtmlTemplateBase64 = ReadFileBase64("path/to/your/template.html"),
Filter = @" URL == ""/example""
",
BotsActionInQueuingMode = "WAIT_IN_LINE",
EntranceRateThreshold = 600,
ConcurrentSessionsThreshold = 600,
InactivityTimeout = 30,
QueueInactivityTimeout = 1,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incapsula.WaitingRoom;
import com.pulumi.incapsula.WaitingRoomArgs;
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_waiting_room = new WaitingRoom("example-waiting-room", WaitingRoomArgs.builder()
.siteId(incapsula_site.example-site().id())
.description("Waiting room description")
.enabled(true)
.htmlTemplateBase64(Base64.getEncoder().encodeToString(Files.readAllBytes(Paths.get("path/to/your/template.html"))))
.filter("""
URL == "/example"
""")
.botsActionInQueuingMode("WAIT_IN_LINE")
.entranceRateThreshold(600)
.concurrentSessionsThreshold(600)
.inactivityTimeout(30)
.queueInactivityTimeout(1)
.build());
}
}
Coming soon!
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,
site_id: Optional[str] = None,
filter: Optional[str] = None,
concurrent_sessions_threshold: Optional[float] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
entrance_rate_threshold: Optional[float] = None,
account_id: Optional[str] = None,
html_template_base64: Optional[str] = None,
inactivity_timeout: Optional[float] = None,
name: Optional[str] = None,
queue_inactivity_timeout: Optional[float] = None,
bots_action_in_queuing_mode: Optional[str] = None,
waiting_room_id: 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: incapsula:WaitingRoom
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WaitingRoomArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args WaitingRoomArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WaitingRoomArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 Incapsula.WaitingRoom("waitingRoomResource", new()
{
SiteId = "string",
Filter = "string",
ConcurrentSessionsThreshold = 0,
Description = "string",
Enabled = false,
EntranceRateThreshold = 0,
AccountId = "string",
HtmlTemplateBase64 = "string",
InactivityTimeout = 0,
Name = "string",
QueueInactivityTimeout = 0,
BotsActionInQueuingMode = "string",
WaitingRoomId = "string",
});
example, err := incapsula.NewWaitingRoom(ctx, "waitingRoomResource", &incapsula.WaitingRoomArgs{
SiteId: pulumi.String("string"),
Filter: pulumi.String("string"),
ConcurrentSessionsThreshold: pulumi.Float64(0),
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
EntranceRateThreshold: pulumi.Float64(0),
AccountId: pulumi.String("string"),
HtmlTemplateBase64: pulumi.String("string"),
InactivityTimeout: pulumi.Float64(0),
Name: pulumi.String("string"),
QueueInactivityTimeout: pulumi.Float64(0),
BotsActionInQueuingMode: pulumi.String("string"),
WaitingRoomId: pulumi.String("string"),
})
var waitingRoomResource = new WaitingRoom("waitingRoomResource", WaitingRoomArgs.builder()
.siteId("string")
.filter("string")
.concurrentSessionsThreshold(0)
.description("string")
.enabled(false)
.entranceRateThreshold(0)
.accountId("string")
.htmlTemplateBase64("string")
.inactivityTimeout(0)
.name("string")
.queueInactivityTimeout(0)
.botsActionInQueuingMode("string")
.waitingRoomId("string")
.build());
waiting_room_resource = incapsula.WaitingRoom("waitingRoomResource",
site_id="string",
filter="string",
concurrent_sessions_threshold=0,
description="string",
enabled=False,
entrance_rate_threshold=0,
account_id="string",
html_template_base64="string",
inactivity_timeout=0,
name="string",
queue_inactivity_timeout=0,
bots_action_in_queuing_mode="string",
waiting_room_id="string")
const waitingRoomResource = new incapsula.WaitingRoom("waitingRoomResource", {
siteId: "string",
filter: "string",
concurrentSessionsThreshold: 0,
description: "string",
enabled: false,
entranceRateThreshold: 0,
accountId: "string",
htmlTemplateBase64: "string",
inactivityTimeout: 0,
name: "string",
queueInactivityTimeout: 0,
botsActionInQueuingMode: "string",
waitingRoomId: "string",
});
type: incapsula:WaitingRoom
properties:
accountId: string
botsActionInQueuingMode: string
concurrentSessionsThreshold: 0
description: string
enabled: false
entranceRateThreshold: 0
filter: string
htmlTemplateBase64: string
inactivityTimeout: 0
name: string
queueInactivityTimeout: 0
siteId: string
waitingRoomId: string
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:
- Site
Id string - Numeric identifier of the site to operate on.
- Account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- Bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- Concurrent
Sessions doubleThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- Description string
- The waiting room description.
- Enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- Entrance
Rate doubleThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- Filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- Html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- Inactivity
Timeout double - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- Name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- Queue
Inactivity doubleTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- Waiting
Room stringId - Unique identifier in the API for the waiting room.
- Site
Id string - Numeric identifier of the site to operate on.
- Account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- Bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- Concurrent
Sessions float64Threshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- Description string
- The waiting room description.
- Enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- Entrance
Rate float64Threshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- Filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- Html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- Inactivity
Timeout float64 - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- Name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- Queue
Inactivity float64Timeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- Waiting
Room stringId - Unique identifier in the API for the waiting room.
- site
Id String - Numeric identifier of the site to operate on.
- account
Id String - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action StringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions DoubleThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- description String
- The waiting room description.
- enabled Boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate DoubleThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter String
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template StringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout Double - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- name String
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity DoubleTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- waiting
Room StringId - Unique identifier in the API for the waiting room.
- site
Id string - Numeric identifier of the site to operate on.
- account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions numberThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- description string
- The waiting room description.
- enabled boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate numberThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout number - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity numberTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- waiting
Room stringId - Unique identifier in the API for the waiting room.
- site_
id str - Numeric identifier of the site to operate on.
- account_
id str - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots_
action_ strin_ queuing_ mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent_
sessions_ floatthreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- description str
- The waiting room description.
- enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- entrance_
rate_ floatthreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter str
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html_
template_ strbase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity_
timeout float - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- name str
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue_
inactivity_ floattimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- waiting_
room_ strid - Unique identifier in the API for the waiting room.
- site
Id String - Numeric identifier of the site to operate on.
- account
Id String - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action StringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions NumberThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- description String
- The waiting room description.
- enabled Boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate NumberThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter String
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template StringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout Number - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- name String
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity NumberTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- waiting
Room StringId - Unique identifier in the API for the waiting room.
Outputs
All input properties are implicitly available as output properties. Additionally, the WaitingRoom resource produces the following output properties:
- Created
At string - (timestamp) When the waiting room was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt - The last configuration change date in milliseconds.
- Last
Modified stringBy - (user email) Last user modifying the waiting room.
- Mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- Created
At string - (timestamp) When the waiting room was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt - The last configuration change date in milliseconds.
- Last
Modified stringBy - (user email) Last user modifying the waiting room.
- Mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- created
At String - (timestamp) When the waiting room was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringAt - The last configuration change date in milliseconds.
- last
Modified StringBy - (user email) Last user modifying the waiting room.
- mode String
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- created
At string - (timestamp) When the waiting room was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringAt - The last configuration change date in milliseconds.
- last
Modified stringBy - (user email) Last user modifying the waiting room.
- mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- created_
at str - (timestamp) When the waiting room was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strat - The last configuration change date in milliseconds.
- last_
modified_ strby - (user email) Last user modifying the waiting room.
- mode str
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- created
At String - (timestamp) When the waiting room was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringAt - The last configuration change date in milliseconds.
- last
Modified StringBy - (user email) Last user modifying the waiting room.
- mode String
- (QUEUING or NOT_QUEUING) Waiting room current mode.
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,
account_id: Optional[str] = None,
bots_action_in_queuing_mode: Optional[str] = None,
concurrent_sessions_threshold: Optional[float] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
entrance_rate_threshold: Optional[float] = None,
filter: Optional[str] = None,
html_template_base64: Optional[str] = None,
inactivity_timeout: Optional[float] = None,
last_modified_at: Optional[str] = None,
last_modified_by: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
queue_inactivity_timeout: Optional[float] = None,
site_id: Optional[str] = None,
waiting_room_id: Optional[str] = None) -> WaitingRoomfunc 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: incapsula:WaitingRoom get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- Bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- Concurrent
Sessions doubleThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- Created
At string - (timestamp) When the waiting room was created.
- Description string
- The waiting room description.
- Enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- Entrance
Rate doubleThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- Filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- Html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- Inactivity
Timeout double - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- Last
Modified stringAt - The last configuration change date in milliseconds.
- Last
Modified stringBy - (user email) Last user modifying the waiting room.
- Mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- Name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- Queue
Inactivity doubleTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- Site
Id string - Numeric identifier of the site to operate on.
- Waiting
Room stringId - Unique identifier in the API for the waiting room.
- Account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- Bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- Concurrent
Sessions float64Threshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- Created
At string - (timestamp) When the waiting room was created.
- Description string
- The waiting room description.
- Enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- Entrance
Rate float64Threshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- Filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- Html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- Inactivity
Timeout float64 - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- Last
Modified stringAt - The last configuration change date in milliseconds.
- Last
Modified stringBy - (user email) Last user modifying the waiting room.
- Mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- Name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- Queue
Inactivity float64Timeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- Site
Id string - Numeric identifier of the site to operate on.
- Waiting
Room stringId - Unique identifier in the API for the waiting room.
- account
Id String - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action StringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions DoubleThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- created
At String - (timestamp) When the waiting room was created.
- description String
- The waiting room description.
- enabled Boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate DoubleThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter String
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template StringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout Double - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- last
Modified StringAt - The last configuration change date in milliseconds.
- last
Modified StringBy - (user email) Last user modifying the waiting room.
- mode String
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- name String
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity DoubleTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- site
Id String - Numeric identifier of the site to operate on.
- waiting
Room StringId - Unique identifier in the API for the waiting room.
- account
Id string - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action stringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions numberThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- created
At string - (timestamp) When the waiting room was created.
- description string
- The waiting room description.
- enabled boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate numberThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter string
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template stringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout number - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- last
Modified stringAt - The last configuration change date in milliseconds.
- last
Modified stringBy - (user email) Last user modifying the waiting room.
- mode string
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- name string
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity numberTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- site
Id string - Numeric identifier of the site to operate on.
- waiting
Room stringId - Unique identifier in the API for the waiting room.
- account_
id str - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots_
action_ strin_ queuing_ mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent_
sessions_ floatthreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- created_
at str - (timestamp) When the waiting room was created.
- description str
- The waiting room description.
- enabled bool
- Indicates if this waiting room is enabled or not. Default: true.
- entrance_
rate_ floatthreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter str
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html_
template_ strbase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity_
timeout float - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- last_
modified_ strat - The last configuration change date in milliseconds.
- last_
modified_ strby - (user email) Last user modifying the waiting room.
- mode str
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- name str
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue_
inactivity_ floattimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- site_
id str - Numeric identifier of the site to operate on.
- waiting_
room_ strid - Unique identifier in the API for the waiting room.
- account
Id String - The account to operate on. If not specified, operation will be performed on the account identified by the authentication parameters.
- bots
Action StringIn Queuing Mode - The waiting room bot handling action. Determines the waiting room behavior for legitimate bots trying to access your website during peak time. Applies only when the activation threshold has been passed and visitors are being sent to the queue. Default:
WAIT_IN_LINEPossible values:WAIT_IN_LINE- Wait in line alongside regular users.BYPASS- Bypass the queue.BLOCK- Block this request.
- concurrent
Sessions NumberThreshold - The waiting room is activated when the number of active users reaches the specified value. Minimum value = 1.
- created
At String - (timestamp) When the waiting room was created.
- description String
- The waiting room description.
- enabled Boolean
- Indicates if this waiting room is enabled or not. Default: true.
- entrance
Rate NumberThreshold - The waiting room is activated when new users per minute exceed the specified value. Minimum of 60 users per minute.
- filter String
- The conditions that determine on which sessions this waiting room applies. For example, you can create a condition to apply the waiting room to a subset of your website, instead of to the entire website, such as: URL contains "^/ShoppingCart". You can also use conditions to create waiting rooms for different visitor groups, such as visitors from different countries. For example, CountryCode == GB. See Rule Filter Parameters for more filtering options. Default: No filter. The room applies to the entire website and all users.
- html
Template StringBase64 - The HTML template file path in Base64 format. A default template is used in case one isn't provided. The following placeholders can be used to insert dynamic information:
$WAITING_ROOM_CONFIG$- Calls a script that periodically updates the status of the user, and reloads the page when the user is allowed to enter the website from the waiting room. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_LOADER$- Used to validate the loading of the page. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_WRAPPER$- Used to validate the content of the template. This parameter is mandatory and should not be modified or deleted.$WAITING_ROOM_POSITION_IN_LINE$- Used to display the user's position in the waiting room queue.$WAITING_ROOM_LAST_STATUS_UPDATE$- Used to display the time of the last status update.$ESTIMATED_TIME_TO_WAIT$- Estimated time to wait.
- inactivity
Timeout Number - Inactivity timeout, from 1 to 30 minutes. If waiting room conditions that limit the scope of the waiting room to a subset of the website have been defined, the user is considered active only when navigating the pages in scope of the conditions. A user who is inactive for a longer period of time is considered as having left the site. On returning to the site, the user needs to wait in line again if the waiting room is active. Tip: When enabling the concurrent_sessions_threshold, the inactivity timeout is very important. Once the site is at full capacity (the threshold has been passed), no new user can access the site until another user leaves and frees up space. To optimize the user experience, we recommend setting a balanced inactivity timeout value — long enough so that the user's session is still open if they return quickly, but not so long that it unnecessarily prevents access to other waiting visitors. The default timeout of 5 minutes is the recommended minimum value. Default: 5 minutes.
- last
Modified StringAt - The last configuration change date in milliseconds.
- last
Modified StringBy - (user email) Last user modifying the waiting room.
- mode String
- (QUEUING or NOT_QUEUING) Waiting room current mode.
- name String
- The waiting room name. Must be unique across all waiting rooms of the site.
- queue
Inactivity NumberTimeout - Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. Default: 1 minute.
- site
Id String - Numeric identifier of the site to operate on.
- waiting
Room StringId - Unique identifier in the API for the waiting room.
Import
Waiting rooms can be imported using the waiting room account_id, site_id and waiting_room_id separated by /, e.g.:
$ pulumi import incapsula:index/waitingRoom:WaitingRoom example-waiting-room account_id/site_id/waiting_room_id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- incapsula imperva/terraform-provider-incapsula
- License
- Notes
- This Pulumi package is based on the
incapsulaTerraform Provider.
incapsula 3.33.0 published on Wednesday, Apr 30, 2025 by imperva