Skip to content

waitingRoomEvent.python.md

Latest commit

 

History

History
1914 lines (1209 loc) · 83.9 KB

waitingRoomEvent.python.md

File metadata and controls

1914 lines (1209 loc) · 83.9 KB

waitingRoomEvent Submodule

Constructs

WaitingRoomEvent

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event cloudflare_waiting_room_event}.

Initializers 

from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  event_end_time: str,
  event_start_time: str,
  name: str,
  waiting_room_id: str,
  custom_page_html: str = None,
  description: str = None,
  disable_session_renewal: bool | IResolvable = None,
  new_users_per_minute: typing.Union[int, float] = None,
  prequeue_start_time: str = None,
  queueing_method: str = None,
  session_duration: typing.Union[int, float] = None,
  shuffle_at_event_start: bool | IResolvable = None,
  suspended: bool | IResolvable = None,
  total_active_users: typing.Union[int, float] = None,
  turnstile_action: str = None,
  turnstile_mode: str = None,
  zone_id: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
event_end_time str An ISO 8601 timestamp that marks the end of the event.
event_start_time str An ISO 8601 timestamp that marks the start of the event.
name str A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
waiting_room_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#waiting_room_id WaitingRoomEvent#waiting_room_id}.
custom_page_html str If set, the event will override the waiting room's custom_page_html property while it is active.
description str A note that you can use to add more details about the event.
disable_session_renewal bool | cdktn.IResolvable If set, the event will override the waiting room's disable_session_renewal property while it is active.
new_users_per_minute typing.Union[int, float] If set, the event will override the waiting room's new_users_per_minute property while it is active.
prequeue_start_time str An ISO 8601 timestamp that marks when to begin queueing all users before the event starts.
queueing_method str If set, the event will override the waiting room's queueing_method property while it is active.
session_duration typing.Union[int, float] If set, the event will override the waiting room's session_duration property while it is active.
shuffle_at_event_start bool | cdktn.IResolvable If enabled, users in the prequeue will be shuffled randomly at the event_start_time.
suspended bool | cdktn.IResolvable Suspends or allows an event.
total_active_users typing.Union[int, float] If set, the event will override the waiting room's total_active_users property while it is active.
turnstile_action str If set, the event will override the waiting room's turnstile_action property while it is active.
turnstile_mode str If set, the event will override the waiting room's turnstile_mode property while it is active.
zone_id str Identifier.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional
  • Type: cdktn.ITerraformIterator
lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle
providerOptional
  • Type: cdktn.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
event_end_timeRequired
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#event_end_time WaitingRoomEvent#event_end_time}

event_start_timeRequired
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#event_start_time WaitingRoomEvent#event_start_time}

nameRequired
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#name WaitingRoomEvent#name}

waiting_room_idRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#waiting_room_id WaitingRoomEvent#waiting_room_id}.

custom_page_htmlOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#custom_page_html WaitingRoomEvent#custom_page_html}

descriptionOptional
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#description WaitingRoomEvent#description}

disable_session_renewalOptional
  • Type: bool | cdktn.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#disable_session_renewal WaitingRoomEvent#disable_session_renewal}

new_users_per_minuteOptional
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#new_users_per_minute WaitingRoomEvent#new_users_per_minute}

prequeue_start_timeOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#prequeue_start_time WaitingRoomEvent#prequeue_start_time}

queueing_methodOptional
  • Type: str

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

If null, the event will inherit it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#queueing_method WaitingRoomEvent#queueing_method}

session_durationOptional
  • Type: typing.Union[int, float]

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

If null, the event will inherit it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#session_duration WaitingRoomEvent#session_duration}

shuffle_at_event_startOptional
  • Type: bool | cdktn.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#shuffle_at_event_start WaitingRoomEvent#shuffle_at_event_start}

suspendedOptional
  • Type: bool | cdktn.IResolvable

Suspends or allows an event.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#suspended WaitingRoomEvent#suspended}

total_active_usersOptional
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#total_active_users WaitingRoomEvent#total_active_users}

turnstile_actionOptional
  • Type: str

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

If null, the event will inherit it. Available values: "log", "infinite_queue".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#turnstile_action WaitingRoomEvent#turnstile_action}

turnstile_modeOptional
  • Type: str

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

If null, the event will inherit it. Available values: "off", "invisible", "visible_non_interactive", "visible_managed".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#turnstile_mode WaitingRoomEvent#turnstile_mode}

zone_idOptional
  • Type: str

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#zone_id WaitingRoomEvent#zone_id}

Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_custom_page_html No description.
reset_description No description.
reset_disable_session_renewal No description.
reset_new_users_per_minute No description.
reset_prequeue_start_time No description.
reset_queueing_method No description.
reset_session_duration No description.
reset_shuffle_at_event_start No description.
reset_suspended No description.
reset_total_active_users No description.
reset_turnstile_action No description.
reset_turnstile_mode No description.
reset_zone_id No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

with 
def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktn.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: str | typing.Union[int, float]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

reset_custom_page_html 
def reset_custom_page_html() -> None
reset_description 
def reset_description() -> None
reset_disable_session_renewal 
def reset_disable_session_renewal() -> None
reset_new_users_per_minute 
def reset_new_users_per_minute() -> None
reset_prequeue_start_time 
def reset_prequeue_start_time() -> None
reset_queueing_method 
def reset_queueing_method() -> None
reset_session_duration 
def reset_session_duration() -> None
reset_shuffle_at_event_start 
def reset_shuffle_at_event_start() -> None
reset_suspended 
def reset_suspended() -> None
reset_total_active_users 
def reset_total_active_users() -> None
reset_turnstile_action 
def reset_turnstile_action() -> None
reset_turnstile_mode 
def reset_turnstile_mode() -> None
reset_zone_id 
def reset_zone_id() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a WaitingRoomEvent resource upon running "cdktn plan ".
is_construct 
from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a WaitingRoomEvent resource upon running "cdktn plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the WaitingRoomEvent to import.

import_from_idRequired
  • Type: str

The id of the existing WaitingRoomEvent that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the WaitingRoomEvent to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
created_on str No description.
id str No description.
modified_on str No description.
custom_page_html_input str No description.
description_input str No description.
disable_session_renewal_input bool | cdktn.IResolvable No description.
event_end_time_input str No description.
event_start_time_input str No description.
name_input str No description.
new_users_per_minute_input typing.Union[int, float] No description.
prequeue_start_time_input str No description.
queueing_method_input str No description.
session_duration_input typing.Union[int, float] No description.
shuffle_at_event_start_input bool | cdktn.IResolvable No description.
suspended_input bool | cdktn.IResolvable No description.
total_active_users_input typing.Union[int, float] No description.
turnstile_action_input str No description.
turnstile_mode_input str No description.
waiting_room_id_input str No description.
zone_id_input str No description.
custom_page_html str No description.
description str No description.
disable_session_renewal bool | cdktn.IResolvable No description.
event_end_time str No description.
event_start_time str No description.
name str No description.
new_users_per_minute typing.Union[int, float] No description.
prequeue_start_time str No description.
queueing_method str No description.
session_duration typing.Union[int, float] No description.
shuffle_at_event_start bool | cdktn.IResolvable No description.
suspended bool | cdktn.IResolvable No description.
total_active_users typing.Union[int, float] No description.
turnstile_action str No description.
turnstile_mode str No description.
waiting_room_id str No description.
zone_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
created_onRequired 
created_on: str
  • Type: str
idRequired 
id: str
  • Type: str
modified_onRequired 
modified_on: str
  • Type: str
custom_page_html_inputOptional 
custom_page_html_input: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
disable_session_renewal_inputOptional 
disable_session_renewal_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
event_end_time_inputOptional 
event_end_time_input: str
  • Type: str
event_start_time_inputOptional 
event_start_time_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
new_users_per_minute_inputOptional 
new_users_per_minute_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
prequeue_start_time_inputOptional 
prequeue_start_time_input: str
  • Type: str
queueing_method_inputOptional 
queueing_method_input: str
  • Type: str
session_duration_inputOptional 
session_duration_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
shuffle_at_event_start_inputOptional 
shuffle_at_event_start_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
suspended_inputOptional 
suspended_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable
total_active_users_inputOptional 
total_active_users_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
turnstile_action_inputOptional 
turnstile_action_input: str
  • Type: str
turnstile_mode_inputOptional 
turnstile_mode_input: str
  • Type: str
waiting_room_id_inputOptional 
waiting_room_id_input: str
  • Type: str
zone_id_inputOptional 
zone_id_input: str
  • Type: str
custom_page_htmlRequired 
custom_page_html: str
  • Type: str
descriptionRequired 
description: str
  • Type: str
disable_session_renewalRequired 
disable_session_renewal: bool | IResolvable
  • Type: bool | cdktn.IResolvable
event_end_timeRequired 
event_end_time: str
  • Type: str
event_start_timeRequired 
event_start_time: str
  • Type: str
nameRequired 
name: str
  • Type: str
new_users_per_minuteRequired 
new_users_per_minute: typing.Union[int, float]
  • Type: typing.Union[int, float]
prequeue_start_timeRequired 
prequeue_start_time: str
  • Type: str
queueing_methodRequired 
queueing_method: str
  • Type: str
session_durationRequired 
session_duration: typing.Union[int, float]
  • Type: typing.Union[int, float]
shuffle_at_event_startRequired 
shuffle_at_event_start: bool | IResolvable
  • Type: bool | cdktn.IResolvable
suspendedRequired 
suspended: bool | IResolvable
  • Type: bool | cdktn.IResolvable
total_active_usersRequired 
total_active_users: typing.Union[int, float]
  • Type: typing.Union[int, float]
turnstile_actionRequired 
turnstile_action: str
  • Type: str
turnstile_modeRequired 
turnstile_mode: str
  • Type: str
waiting_room_idRequired 
waiting_room_id: str
  • Type: str
zone_idRequired 
zone_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

WaitingRoomEventConfig

Initializer 

from cdktn_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEventConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  event_end_time: str,
  event_start_time: str,
  name: str,
  waiting_room_id: str,
  custom_page_html: str = None,
  description: str = None,
  disable_session_renewal: bool | IResolvable = None,
  new_users_per_minute: typing.Union[int, float] = None,
  prequeue_start_time: str = None,
  queueing_method: str = None,
  session_duration: typing.Union[int, float] = None,
  shuffle_at_event_start: bool | IResolvable = None,
  suspended: bool | IResolvable = None,
  total_active_users: typing.Union[int, float] = None,
  turnstile_action: str = None,
  turnstile_mode: str = None,
  zone_id: str = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
event_end_time str An ISO 8601 timestamp that marks the end of the event.
event_start_time str An ISO 8601 timestamp that marks the start of the event.
name str A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
waiting_room_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#waiting_room_id WaitingRoomEvent#waiting_room_id}.
custom_page_html str If set, the event will override the waiting room's custom_page_html property while it is active.
description str A note that you can use to add more details about the event.
disable_session_renewal bool | cdktn.IResolvable If set, the event will override the waiting room's disable_session_renewal property while it is active.
new_users_per_minute typing.Union[int, float] If set, the event will override the waiting room's new_users_per_minute property while it is active.
prequeue_start_time str An ISO 8601 timestamp that marks when to begin queueing all users before the event starts.
queueing_method str If set, the event will override the waiting room's queueing_method property while it is active.
session_duration typing.Union[int, float] If set, the event will override the waiting room's session_duration property while it is active.
shuffle_at_event_start bool | cdktn.IResolvable If enabled, users in the prequeue will be shuffled randomly at the event_start_time.
suspended bool | cdktn.IResolvable Suspends or allows an event.
total_active_users typing.Union[int, float] If set, the event will override the waiting room's total_active_users property while it is active.
turnstile_action str If set, the event will override the waiting room's turnstile_action property while it is active.
turnstile_mode str If set, the event will override the waiting room's turnstile_mode property while it is active.
zone_id str Identifier.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktn.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]
event_end_timeRequired 
event_end_time: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#event_end_time WaitingRoomEvent#event_end_time}

event_start_timeRequired 
event_start_time: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#event_start_time WaitingRoomEvent#event_start_time}

nameRequired 
name: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#name WaitingRoomEvent#name}

waiting_room_idRequired 
waiting_room_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#waiting_room_id WaitingRoomEvent#waiting_room_id}.

custom_page_htmlOptional 
custom_page_html: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#custom_page_html WaitingRoomEvent#custom_page_html}

descriptionOptional 
description: str
  • Type: str

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#description WaitingRoomEvent#description}

disable_session_renewalOptional 
disable_session_renewal: bool | IResolvable
  • Type: bool | cdktn.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#disable_session_renewal WaitingRoomEvent#disable_session_renewal}

new_users_per_minuteOptional 
new_users_per_minute: typing.Union[int, float]
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#new_users_per_minute WaitingRoomEvent#new_users_per_minute}

prequeue_start_timeOptional 
prequeue_start_time: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#prequeue_start_time WaitingRoomEvent#prequeue_start_time}

queueing_methodOptional 
queueing_method: str
  • Type: str

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

If null, the event will inherit it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#queueing_method WaitingRoomEvent#queueing_method}

session_durationOptional 
session_duration: typing.Union[int, float]
  • Type: typing.Union[int, float]

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

If null, the event will inherit it.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#session_duration WaitingRoomEvent#session_duration}

shuffle_at_event_startOptional 
shuffle_at_event_start: bool | IResolvable
  • Type: bool | cdktn.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#shuffle_at_event_start WaitingRoomEvent#shuffle_at_event_start}

suspendedOptional 
suspended: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Suspends or allows an event.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#suspended WaitingRoomEvent#suspended}

total_active_usersOptional 
total_active_users: typing.Union[int, float]
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#total_active_users WaitingRoomEvent#total_active_users}

turnstile_actionOptional 
turnstile_action: str
  • Type: str

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

If null, the event will inherit it. Available values: "log", "infinite_queue".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#turnstile_action WaitingRoomEvent#turnstile_action}

turnstile_modeOptional 
turnstile_mode: str
  • Type: str

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

If null, the event will inherit it. Available values: "off", "invisible", "visible_non_interactive", "visible_managed".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#turnstile_mode WaitingRoomEvent#turnstile_mode}

zone_idOptional 
zone_id: str
  • Type: str

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs/resources/waiting_room_event#zone_id WaitingRoomEvent#zone_id}