import * as pulumi from "@pulumi/pulumi"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cloudflare from "@pulumi/cloudflare"; * * const exampleWaitingRoomEvent = new cloudflare.WaitingRoomEvent("example_waiting_room_event", { * zoneId: "023e105f4ecef8ad9ca31a8372d0c353", * waitingRoomId: "699d98642c564d2e855e9661899b7252", * eventEndTime: "2021-09-28T17:00:00.000Z", * eventStartTime: "2021-09-28T15:30:00.000Z", * name: "production_webinar_event", * customPageHtml: "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}", * description: "Production event - DO NOT MODIFY", * disableSessionRenewal: true, * newUsersPerMinute: 200, * prequeueStartTime: "2021-09-28T15:00:00.000Z", * queueingMethod: "random", * sessionDuration: 1, * shuffleAtEventStart: true, * suspended: true, * totalActiveUsers: 200, * turnstileAction: "log", * turnstileMode: "off", * }); * ``` * * ## Import * * ```sh * $ pulumi import cloudflare:index/waitingRoomEvent:WaitingRoomEvent example '//' * ``` */ export declare class WaitingRoomEvent extends pulumi.CustomResource { /** * Get an existing WaitingRoomEvent 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?: WaitingRoomEventState, opts?: pulumi.CustomResourceOptions): WaitingRoomEvent; /** * Returns true if the given object is an instance of WaitingRoomEvent. 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 WaitingRoomEvent; readonly createdOn: pulumi.Output; /** * If set, the event will override the waiting room's `customPageHtml` property while it is active. If null, the event will inherit it. */ readonly customPageHtml: pulumi.Output; /** * A note that you can use to add more details about the event. */ readonly description: pulumi.Output; /** * If set, the event will override the waiting room's `disableSessionRenewal` property while it is active. If null, the event will inherit it. */ readonly disableSessionRenewal: pulumi.Output; /** * An ISO 8601 timestamp that marks the end of the event. */ readonly eventEndTime: pulumi.Output; /** * An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eventEndTime`. */ readonly eventStartTime: pulumi.Output; readonly modifiedOn: pulumi.Output; /** * A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ readonly name: pulumi.Output; /** * If set, the event will override the waiting room's `newUsersPerMinute` property while it is active. If null, the event will inherit it. This can only be set if the event's `totalActiveUsers` property is also set. */ readonly newUsersPerMinute: pulumi.Output; /** * An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `eventStartTime`. */ readonly prequeueStartTime: pulumi.Output; /** * If set, the event will override the waiting room's `queueingMethod` property while it is active. If null, the event will inherit it. */ readonly queueingMethod: pulumi.Output; /** * If set, the event will override the waiting room's `sessionDuration` property while it is active. If null, the event will inherit it. */ readonly sessionDuration: pulumi.Output; /** * If enabled, users in the prequeue will be shuffled randomly at the `eventStartTime`. Requires that `prequeueStartTime` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueingMethod` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ readonly shuffleAtEventStart: pulumi.Output; /** * Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ readonly suspended: pulumi.Output; /** * If set, the event will override the waiting room's `totalActiveUsers` property while it is active. If null, the event will inherit it. This can only be set if the event's `newUsersPerMinute` property is also set. */ readonly totalActiveUsers: pulumi.Output; /** * If set, the event will override the waiting room's `turnstileAction` property while it is active. If null, the event will inherit it. * Available values: "log", "infiniteQueue". */ readonly turnstileAction: pulumi.Output; /** * If set, the event will override the waiting room's `turnstileMode` property while it is active. If null, the event will inherit it. * Available values: "off", "invisible", "visible*non*interactive", "visibleManaged". */ readonly turnstileMode: pulumi.Output; readonly waitingRoomId: pulumi.Output; /** * Identifier. */ readonly zoneId: pulumi.Output; /** * Create a WaitingRoomEvent 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: WaitingRoomEventArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WaitingRoomEvent resources. */ export interface WaitingRoomEventState { createdOn?: pulumi.Input; /** * If set, the event will override the waiting room's `customPageHtml` property while it is active. If null, the event will inherit it. */ customPageHtml?: pulumi.Input; /** * A note that you can use to add more details about the event. */ description?: pulumi.Input; /** * If set, the event will override the waiting room's `disableSessionRenewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: pulumi.Input; /** * An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: pulumi.Input; /** * An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eventEndTime`. */ eventStartTime?: pulumi.Input; modifiedOn?: pulumi.Input; /** * A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: pulumi.Input; /** * If set, the event will override the waiting room's `newUsersPerMinute` property while it is active. If null, the event will inherit it. This can only be set if the event's `totalActiveUsers` property is also set. */ newUsersPerMinute?: pulumi.Input; /** * An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `eventStartTime`. */ prequeueStartTime?: pulumi.Input; /** * If set, the event will override the waiting room's `queueingMethod` property while it is active. If null, the event will inherit it. */ queueingMethod?: pulumi.Input; /** * If set, the event will override the waiting room's `sessionDuration` property while it is active. If null, the event will inherit it. */ sessionDuration?: pulumi.Input; /** * If enabled, users in the prequeue will be shuffled randomly at the `eventStartTime`. Requires that `prequeueStartTime` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueingMethod` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: pulumi.Input; /** * Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: pulumi.Input; /** * If set, the event will override the waiting room's `totalActiveUsers` property while it is active. If null, the event will inherit it. This can only be set if the event's `newUsersPerMinute` property is also set. */ totalActiveUsers?: pulumi.Input; /** * If set, the event will override the waiting room's `turnstileAction` property while it is active. If null, the event will inherit it. * Available values: "log", "infiniteQueue". */ turnstileAction?: pulumi.Input; /** * If set, the event will override the waiting room's `turnstileMode` property while it is active. If null, the event will inherit it. * Available values: "off", "invisible", "visible*non*interactive", "visibleManaged". */ turnstileMode?: pulumi.Input; waitingRoomId?: pulumi.Input; /** * Identifier. */ zoneId?: pulumi.Input; } /** * The set of arguments for constructing a WaitingRoomEvent resource. */ export interface WaitingRoomEventArgs { /** * If set, the event will override the waiting room's `customPageHtml` property while it is active. If null, the event will inherit it. */ customPageHtml?: pulumi.Input; /** * A note that you can use to add more details about the event. */ description?: pulumi.Input; /** * If set, the event will override the waiting room's `disableSessionRenewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: pulumi.Input; /** * An ISO 8601 timestamp that marks the end of the event. */ eventEndTime: pulumi.Input; /** * An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `eventEndTime`. */ eventStartTime: pulumi.Input; /** * A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name: pulumi.Input; /** * If set, the event will override the waiting room's `newUsersPerMinute` property while it is active. If null, the event will inherit it. This can only be set if the event's `totalActiveUsers` property is also set. */ newUsersPerMinute?: pulumi.Input; /** * An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `eventStartTime`. */ prequeueStartTime?: pulumi.Input; /** * If set, the event will override the waiting room's `queueingMethod` property while it is active. If null, the event will inherit it. */ queueingMethod?: pulumi.Input; /** * If set, the event will override the waiting room's `sessionDuration` property while it is active. If null, the event will inherit it. */ sessionDuration?: pulumi.Input; /** * If enabled, users in the prequeue will be shuffled randomly at the `eventStartTime`. Requires that `prequeueStartTime` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueingMethod` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: pulumi.Input; /** * Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: pulumi.Input; /** * If set, the event will override the waiting room's `totalActiveUsers` property while it is active. If null, the event will inherit it. This can only be set if the event's `newUsersPerMinute` property is also set. */ totalActiveUsers?: pulumi.Input; /** * If set, the event will override the waiting room's `turnstileAction` property while it is active. If null, the event will inherit it. * Available values: "log", "infiniteQueue". */ turnstileAction?: pulumi.Input; /** * If set, the event will override the waiting room's `turnstileMode` property while it is active. If null, the event will inherit it. * Available values: "off", "invisible", "visible*non*interactive", "visibleManaged". */ turnstileMode?: pulumi.Input; waitingRoomId: pulumi.Input; /** * Identifier. */ zoneId: pulumi.Input; }