`waitingRoomEvent` Submodule

Constructs

WaitingRoomEvent

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

Initializers

from cdktf_cdktf_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEvent(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  event_end_time: str,
  event_start_time: str,
  name: str,
  waiting_room_id: str,
  zone_id: str,
  custom_page_html: str = None,
  description: str = None,
  disable_session_renewal: typing.Union[bool, IResolvable] = None,
  id: str = 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: typing.Union[bool, IResolvable] = None,
  suspended: typing.Union[bool, IResolvable] = None,
  total_active_users: typing.Union[int, float] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`event_end_time`	`str`	ISO 8601 timestamp that marks the end of the event.
`event_start_time`	`str`	ISO 8601 timestamp that marks the start of the event.
`name`	`str`	A unique name to identify the event.
`waiting_room_id`	`str`	The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource..
`zone_id`	`str`	The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
`custom_page_html`	`str`	This is a templated html file that will be rendered at the edge.
`description`	`str`	A description to let users add more details about the event.
`disable_session_renewal`	`typing.Union[bool, cdktf.IResolvable]`	Disables automatic renewal of session cookies.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/waiting_room_event#id WaitingRoomEvent#id}.
`new_users_per_minute`	`typing.Union[int, float]`	The number of new users that will be let into the route every minute.
`prequeue_start_time`	`str`	ISO 8601 timestamp that marks when to begin queueing all users before the event starts.
`queueing_method`	`str`	The queueing method used by the waiting room. Available values: `fifo`, `random`, `passthrough`, `reject`.
`session_duration`	`typing.Union[int, float]`	Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
`shuffle_at_event_start`	`typing.Union[bool, cdktf.IResolvable]`	Users in the prequeue will be shuffled randomly at the `event_start_time`.
`suspended`	`typing.Union[bool, cdktf.IResolvable]`	If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
`total_active_users`	`typing.Union[int, float]`	The total number of active user sessions on the route at a point in time.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`event_end_time`^Required

Type: str

ISO 8601 timestamp that marks the end of the event.

Modifying this attribute will force creation of a new resource.

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

`event_start_time`^Required

Type: str

ISO 8601 timestamp that marks the start of the event.

Must occur at least 1 minute before event_end_time. Modifying this attribute will force creation of a new resource.

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

`name`^Required

Type: str

A unique name to identify the event.

Only alphanumeric characters, hyphens, and underscores are allowed. Modifying this attribute will force creation of a new resource.

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

`waiting_room_id`^Required

Type: str

The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource..

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

`zone_id`^Required

Type: str

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

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

`custom_page_html`^Optional

Type: str

This is a templated html file that will be rendered at the edge.

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

`description`^Optional

Type: str

A description to let users add more details about the event.

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

`disable_session_renewal`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Disables automatic renewal of session cookies.

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

`id`^Optional

Type: str

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`new_users_per_minute`^Optional

Type: typing.Union[int, float]

The number of new users that will be let into the route every minute.

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

`prequeue_start_time`^Optional

Type: str

ISO 8601 timestamp that marks when to begin queueing all users before the event starts.

Must occur at least 5 minutes before event_start_time.

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

`queueing_method`^Optional

Type: str

The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.

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

`session_duration`^Optional

Type: typing.Union[int, float]

Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.

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

`shuffle_at_event_start`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Users in the prequeue will be shuffled randomly at the event_start_time.

Requires that prequeue_start_time is not null. Defaults to false.

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

`suspended`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

If suspended, 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/4.50.0/docs/resources/waiting_room_event#suspended WaitingRoomEvent#suspended}

`total_active_users`^Optional

Type: typing.Union[int, float]

The total number of active user sessions on the route at a point in time.

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

Methods

Name	Description
`to_string`	Returns a string representation of 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_id`	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.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

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_id`^Required

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_target`^Required

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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

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.

`id`^Required

Type: str

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

`move_to`

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

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: typing.Union[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".

`id`^Required

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_id`

def reset_id() -> 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

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 CDKTF code for importing a WaitingRoomEvent resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_cloudflare import waiting_room_event

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

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_cloudflare import waiting_room_event

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

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_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 CDKTF code for importing a WaitingRoomEvent resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing WaitingRoomEvent that should be imported.

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

`provider`^Optional

Type: cdktf.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`	`cdktf.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`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`created_on`	`str`	No description.
`modified_on`	`str`	No description.
`custom_page_html_input`	`str`	No description.
`description_input`	`str`	No description.
`disable_session_renewal_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`event_end_time_input`	`str`	No description.
`event_start_time_input`	`str`	No description.
`id_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`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`suspended_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`total_active_users_input`	`typing.Union[int, float]`	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`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`event_end_time`	`str`	No description.
`event_start_time`	`str`	No description.
`id`	`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`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`suspended`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`total_active_users`	`typing.Union[int, float]`	No description.
`waiting_room_id`	`str`	No description.
`zone_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`created_on`^Required

created_on: str

Type: str

`modified_on`^Required

modified_on: str

Type: str

`custom_page_html_input`^Optional

custom_page_html_input: str

Type: str

`description_input`^Optional

description_input: str

Type: str

`disable_session_renewal_input`^Optional

disable_session_renewal_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`event_end_time_input`^Optional

event_end_time_input: str

Type: str

`event_start_time_input`^Optional

event_start_time_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`new_users_per_minute_input`^Optional

new_users_per_minute_input: typing.Union[int, float]

Type: typing.Union[int, float]

`prequeue_start_time_input`^Optional

prequeue_start_time_input: str

Type: str

`queueing_method_input`^Optional

queueing_method_input: str

Type: str

`session_duration_input`^Optional

session_duration_input: typing.Union[int, float]

Type: typing.Union[int, float]

`shuffle_at_event_start_input`^Optional

shuffle_at_event_start_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`suspended_input`^Optional

suspended_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`total_active_users_input`^Optional

total_active_users_input: typing.Union[int, float]

Type: typing.Union[int, float]

`waiting_room_id_input`^Optional

waiting_room_id_input: str

Type: str

`zone_id_input`^Optional

zone_id_input: str

Type: str

`custom_page_html`^Required

custom_page_html: str

Type: str

`description`^Required

description: str

Type: str

`disable_session_renewal`^Required

disable_session_renewal: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`event_end_time`^Required

event_end_time: str

Type: str

`event_start_time`^Required

event_start_time: str

Type: str

`id`^Required

id: str

Type: str

`name`^Required

name: str

Type: str

`new_users_per_minute`^Required

new_users_per_minute: typing.Union[int, float]

Type: typing.Union[int, float]

`prequeue_start_time`^Required

prequeue_start_time: str

Type: str

`queueing_method`^Required

queueing_method: str

Type: str

`session_duration`^Required

session_duration: typing.Union[int, float]

Type: typing.Union[int, float]

`shuffle_at_event_start`^Required

shuffle_at_event_start: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`suspended`^Required

suspended: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`total_active_users`^Required

total_active_users: typing.Union[int, float]

Type: typing.Union[int, float]

`waiting_room_id`^Required

waiting_room_id: str

Type: str

`zone_id`^Required

zone_id: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

WaitingRoomEventConfig

Initializer

from cdktf_cdktf_provider_cloudflare import waiting_room_event

waitingRoomEvent.WaitingRoomEventConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[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[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  event_end_time: str,
  event_start_time: str,
  name: str,
  waiting_room_id: str,
  zone_id: str,
  custom_page_html: str = None,
  description: str = None,
  disable_session_renewal: typing.Union[bool, IResolvable] = None,
  id: str = 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: typing.Union[bool, IResolvable] = None,
  suspended: typing.Union[bool, IResolvable] = None,
  total_active_users: typing.Union[int, float] = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`event_end_time`	`str`	ISO 8601 timestamp that marks the end of the event.
`event_start_time`	`str`	ISO 8601 timestamp that marks the start of the event.
`name`	`str`	A unique name to identify the event.
`waiting_room_id`	`str`	The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource..
`zone_id`	`str`	The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
`custom_page_html`	`str`	This is a templated html file that will be rendered at the edge.
`description`	`str`	A description to let users add more details about the event.
`disable_session_renewal`	`typing.Union[bool, cdktf.IResolvable]`	Disables automatic renewal of session cookies.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.50.0/docs/resources/waiting_room_event#id WaitingRoomEvent#id}.
`new_users_per_minute`	`typing.Union[int, float]`	The number of new users that will be let into the route every minute.
`prequeue_start_time`	`str`	ISO 8601 timestamp that marks when to begin queueing all users before the event starts.
`queueing_method`	`str`	The queueing method used by the waiting room. Available values: `fifo`, `random`, `passthrough`, `reject`.
`session_duration`	`typing.Union[int, float]`	Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
`shuffle_at_event_start`	`typing.Union[bool, cdktf.IResolvable]`	Users in the prequeue will be shuffled randomly at the `event_start_time`.
`suspended`	`typing.Union[bool, cdktf.IResolvable]`	If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
`total_active_users`	`typing.Union[int, float]`	The total number of active user sessions on the route at a point in time.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`event_end_time`^Required

event_end_time: str

Type: str

ISO 8601 timestamp that marks the end of the event.

Modifying this attribute will force creation of a new resource.

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

`event_start_time`^Required

event_start_time: str

Type: str

ISO 8601 timestamp that marks the start of the event.

Must occur at least 1 minute before event_end_time. Modifying this attribute will force creation of a new resource.

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

`name`^Required

name: str

Type: str

A unique name to identify the event.

Only alphanumeric characters, hyphens, and underscores are allowed. Modifying this attribute will force creation of a new resource.

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

`waiting_room_id`^Required

waiting_room_id: str

Type: str

The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource..

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

`zone_id`^Required

zone_id: str

Type: str

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

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

`custom_page_html`^Optional

custom_page_html: str

Type: str

This is a templated html file that will be rendered at the edge.

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

`description`^Optional

description: str

Type: str

A description to let users add more details about the event.

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

`disable_session_renewal`^Optional

disable_session_renewal: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Disables automatic renewal of session cookies.

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

`id`^Optional

id: str

Type: str

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`new_users_per_minute`^Optional

new_users_per_minute: typing.Union[int, float]

Type: typing.Union[int, float]

The number of new users that will be let into the route every minute.

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

`prequeue_start_time`^Optional

prequeue_start_time: str

Type: str

ISO 8601 timestamp that marks when to begin queueing all users before the event starts.

Must occur at least 5 minutes before event_start_time.

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

`queueing_method`^Optional

queueing_method: str

Type: str

The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.

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

`session_duration`^Optional

session_duration: typing.Union[int, float]

Type: typing.Union[int, float]

Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.

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

`shuffle_at_event_start`^Optional

shuffle_at_event_start: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Users in the prequeue will be shuffled randomly at the event_start_time.

Requires that prequeue_start_time is not null. Defaults to false.

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

`suspended`^Optional

suspended: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

If suspended, 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/4.50.0/docs/resources/waiting_room_event#suspended WaitingRoomEvent#suspended}

`total_active_users`^Optional

total_active_users: typing.Union[int, float]

Type: typing.Union[int, float]

The total number of active user sessions on the route at a point in time.

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

Files

waitingRoomEvent.python.md

Latest commit

History

waitingRoomEvent.python.md

File metadata and controls

waitingRoomEvent Submodule

Constructs