import * as pulumi from "@pulumi/pulumi"; /** * Provides a Cloudflare Waiting Room resource. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cloudflare from "@pulumi/cloudflare"; * * const example = new cloudflare.WaitingRoom("example", { * host: "foo.example.com", * name: "foo", * newUsersPerMinute: 200, * path: "/", * totalActiveUsers: 200, * zoneId: "ae36f999674d196762efcc5abb06b345", * }); * ``` * * ## Import * * Waiting rooms can be imported using a composite ID formed of zone ID and waiting room ID, e.g. * * ```sh * $ pulumi import cloudflare:index/waitingRoom:WaitingRoom default ae36f999674d196762efcc5abb06b345/d41d8cd98f00b204e9800998ecf8427e * ``` * * where* `ae36f999674d196762efcc5abb06b345` - the zone ID * `d41d8cd98f00b204e9800998ecf8427e` - waiting room ID as returned by [API](https://api.cloudflare.com/#waiting-room-list-waiting-rooms) */ export declare class WaitingRoom extends pulumi.CustomResource { /** * Get an existing WaitingRoom resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: WaitingRoomState, opts?: pulumi.CustomResourceOptions): WaitingRoom; /** * Returns true if the given object is an instance of WaitingRoom. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is WaitingRoom; /** * This a templated html file that will be rendered at the edge. */ readonly customPageHtml: pulumi.Output; /** * The language to use for the default waiting room page (refer to the nested schema). */ readonly defaultTemplateLanguage: pulumi.Output; /** * A description to let users add more details about the waiting room. */ readonly description: pulumi.Output; /** * Disables automatic renewal of session cookies. Default: false. */ readonly disableSessionRenewal: pulumi.Output; /** * Host name for which the waiting room will be applied (no wildcards). */ readonly host: pulumi.Output; /** * If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object. */ readonly jsonResponseEnabled: pulumi.Output; /** * A unique name to identify the waiting room. */ readonly name: pulumi.Output; /** * The number of new users that will be let into the route every minute. */ readonly newUsersPerMinute: pulumi.Output; /** * The path within the host to enable the waiting room on. Default: "/". */ readonly path: pulumi.Output; /** * If queueAll is true all the traffic that is coming to a route will be sent to the waiting room. Default: false. */ readonly queueAll: pulumi.Output; /** * Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. Default: 5 */ readonly sessionDuration: pulumi.Output; /** * If suspended, the traffic doesn't go to the waiting room. Default: false. */ readonly suspended: pulumi.Output; /** * The total number of active user sessions on the route at a point in time. */ readonly totalActiveUsers: pulumi.Output; /** * The DNS zone ID to apply to. */ readonly zoneId: pulumi.Output; /** * Create a WaitingRoom resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: WaitingRoomArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WaitingRoom resources. */ export interface WaitingRoomState { /** * This a templated html file that will be rendered at the edge. */ customPageHtml?: pulumi.Input; /** * The language to use for the default waiting room page (refer to the nested schema). */ defaultTemplateLanguage?: pulumi.Input; /** * A description to let users add more details about the waiting room. */ description?: pulumi.Input; /** * Disables automatic renewal of session cookies. Default: false. */ disableSessionRenewal?: pulumi.Input; /** * Host name for which the waiting room will be applied (no wildcards). */ host?: pulumi.Input; /** * If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object. */ jsonResponseEnabled?: pulumi.Input; /** * A unique name to identify the waiting room. */ name?: pulumi.Input; /** * The number of new users that will be let into the route every minute. */ newUsersPerMinute?: pulumi.Input; /** * The path within the host to enable the waiting room on. Default: "/". */ path?: pulumi.Input; /** * If queueAll is true all the traffic that is coming to a route will be sent to the waiting room. Default: false. */ queueAll?: pulumi.Input; /** * Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. Default: 5 */ sessionDuration?: pulumi.Input; /** * If suspended, the traffic doesn't go to the waiting room. Default: false. */ suspended?: pulumi.Input; /** * The total number of active user sessions on the route at a point in time. */ totalActiveUsers?: pulumi.Input; /** * The DNS zone ID to apply to. */ zoneId?: pulumi.Input; } /** * The set of arguments for constructing a WaitingRoom resource. */ export interface WaitingRoomArgs { /** * This a templated html file that will be rendered at the edge. */ customPageHtml?: pulumi.Input; /** * The language to use for the default waiting room page (refer to the nested schema). */ defaultTemplateLanguage?: pulumi.Input; /** * A description to let users add more details about the waiting room. */ description?: pulumi.Input; /** * Disables automatic renewal of session cookies. Default: false. */ disableSessionRenewal?: pulumi.Input; /** * Host name for which the waiting room will be applied (no wildcards). */ host: pulumi.Input; /** * If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object. */ jsonResponseEnabled?: pulumi.Input; /** * A unique name to identify the waiting room. */ name: pulumi.Input; /** * The number of new users that will be let into the route every minute. */ newUsersPerMinute: pulumi.Input; /** * The path within the host to enable the waiting room on. Default: "/". */ path?: pulumi.Input; /** * If queueAll is true all the traffic that is coming to a route will be sent to the waiting room. Default: false. */ queueAll?: pulumi.Input; /** * Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. Default: 5 */ sessionDuration?: pulumi.Input; /** * If suspended, the traffic doesn't go to the waiting room. Default: false. */ suspended?: pulumi.Input; /** * The total number of active user sessions on the route at a point in time. */ totalActiveUsers: pulumi.Input; /** * The DNS zone ID to apply to. */ zoneId: pulumi.Input; }