Skip to content
Start here

Events

resource cloudflare_waiting_room_event

required Expand Collapse
waiting_room_id: String
zone_id: String

Identifier.

event_end_time: String

An ISO 8601 timestamp that marks the end of the event.

event_start_time: String

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

name: String

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

optional Expand Collapse
custom_page_html?: String

If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.

disable_session_renewal?: Bool

If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.

new_users_per_minute?: Int64

If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.

prequeue_start_time?: String

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

queueing_method?: String

If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.

session_duration?: Int64

If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.

total_active_users?: Int64

If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.

turnstile_action?: String

If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.

turnstile_mode?: String

If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it.

description?: String

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

shuffle_at_event_start?: Bool

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time 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 queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

suspended?: Bool

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

computed Expand Collapse
id: String
created_on: Time
modified_on: Time

cloudflare_waiting_room_event

resource "cloudflare_waiting_room_event" "example_waiting_room_event" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  waiting_room_id = "699d98642c564d2e855e9661899b7252"
  event_end_time = "2021-09-28T17:00:00.000Z"
  event_start_time = "2021-09-28T15:30:00.000Z"
  name = "production_webinar_event"
  custom_page_html = "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  description = "Production event - DO NOT MODIFY"
  disable_session_renewal = true
  new_users_per_minute = 200
  prequeue_start_time = "2021-09-28T15:00:00.000Z"
  queueing_method = "random"
  session_duration = 1
  shuffle_at_event_start = true
  suspended = true
  total_active_users = 200
  turnstile_action = "log"
  turnstile_mode = "off"
}

data cloudflare_waiting_room_event

required Expand Collapse
event_id: String
waiting_room_id: String
zone_id: String

Identifier.

computed Expand Collapse
id: String
created_on: Time
custom_page_html: String

If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.

description: String

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

disable_session_renewal: Bool

If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.

event_end_time: String

An ISO 8601 timestamp that marks the end of the event.

event_start_time: String

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

modified_on: Time
name: String

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

new_users_per_minute: Int64

If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.

prequeue_start_time: String

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

queueing_method: String

If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.

session_duration: Int64

If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.

shuffle_at_event_start: Bool

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time 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 queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

suspended: Bool

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

total_active_users: Int64

If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.

turnstile_action: String

If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.

turnstile_mode: String

If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it.

cloudflare_waiting_room_event

data "cloudflare_waiting_room_event" "example_waiting_room_event" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  waiting_room_id = "699d98642c564d2e855e9661899b7252"
  event_id = "25756b2dfe6e378a06b033b670413757"
}

data cloudflare_waiting_room_events

required Expand Collapse
waiting_room_id: String
zone_id: String

Identifier.

optional Expand Collapse
max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String
created_on: Time
custom_page_html: String

If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.

description: String

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

disable_session_renewal: Bool

If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.

event_end_time: String

An ISO 8601 timestamp that marks the end of the event.

event_start_time: String

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

modified_on: Time
name: String

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

new_users_per_minute: Int64

If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.

prequeue_start_time: String

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

queueing_method: String

If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.

session_duration: Int64

If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.

shuffle_at_event_start: Bool

If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time 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 queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.

suspended: Bool

Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.

total_active_users: Int64

If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.

turnstile_action: String

If set, the event will override the waiting room's turnstile_action property while it is active. If null, the event will inherit it.

turnstile_mode: String

If set, the event will override the waiting room's turnstile_mode property while it is active. If null, the event will inherit it.

cloudflare_waiting_room_events

data "cloudflare_waiting_room_events" "example_waiting_room_events" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  waiting_room_id = "699d98642c564d2e855e9661899b7252"
}