1. Packages
  2. Cloudflare
  3. API Docs
  4. WaitingRoomEvent
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.WaitingRoomEvent

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a Cloudflare Waiting Room Event resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    // Waiting Room Event
    const example = new cloudflare.WaitingRoomEvent("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        waitingRoomId: "d41d8cd98f00b204e9800998ecf8427e",
        name: "foo",
        eventStartTime: "2006-01-02T15:04:05Z",
        eventEndTime: "2006-01-02T20:04:05Z",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    # Waiting Room Event
    example = cloudflare.WaitingRoomEvent("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        waiting_room_id="d41d8cd98f00b204e9800998ecf8427e",
        name="foo",
        event_start_time="2006-01-02T15:04:05Z",
        event_end_time="2006-01-02T20:04:05Z")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Waiting Room Event
    		_, err := cloudflare.NewWaitingRoomEvent(ctx, "example", &cloudflare.WaitingRoomEventArgs{
    			ZoneId:         pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
    			WaitingRoomId:  pulumi.String("d41d8cd98f00b204e9800998ecf8427e"),
    			Name:           pulumi.String("foo"),
    			EventStartTime: pulumi.String("2006-01-02T15:04:05Z"),
    			EventEndTime:   pulumi.String("2006-01-02T20:04:05Z"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        // Waiting Room Event
        var example = new Cloudflare.WaitingRoomEvent("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            WaitingRoomId = "d41d8cd98f00b204e9800998ecf8427e",
            Name = "foo",
            EventStartTime = "2006-01-02T15:04:05Z",
            EventEndTime = "2006-01-02T20:04:05Z",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.WaitingRoomEvent;
    import com.pulumi.cloudflare.WaitingRoomEventArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Waiting Room Event
            var example = new WaitingRoomEvent("example", WaitingRoomEventArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .waitingRoomId("d41d8cd98f00b204e9800998ecf8427e")
                .name("foo")
                .eventStartTime("2006-01-02T15:04:05Z")
                .eventEndTime("2006-01-02T20:04:05Z")
                .build());
    
        }
    }
    
    resources:
      # Waiting Room Event
      example:
        type: cloudflare:WaitingRoomEvent
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          waitingRoomId: d41d8cd98f00b204e9800998ecf8427e
          name: foo
          eventStartTime: 2006-01-02T15:04:05Z
          eventEndTime: 2006-01-02T20:04:05Z
    

    Create WaitingRoomEvent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WaitingRoomEvent(name: string, args: WaitingRoomEventArgs, opts?: CustomResourceOptions);
    @overload
    def WaitingRoomEvent(resource_name: str,
                         args: WaitingRoomEventArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WaitingRoomEvent(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None,
                         zone_id: Optional[str] = None,
                         waiting_room_id: Optional[str] = None,
                         event_end_time: Optional[str] = None,
                         event_start_time: Optional[str] = None,
                         new_users_per_minute: Optional[int] = None,
                         custom_page_html: Optional[str] = None,
                         prequeue_start_time: Optional[str] = None,
                         queueing_method: Optional[str] = None,
                         session_duration: Optional[int] = None,
                         shuffle_at_event_start: Optional[bool] = None,
                         suspended: Optional[bool] = None,
                         total_active_users: Optional[int] = None,
                         disable_session_renewal: Optional[bool] = None,
                         description: Optional[str] = None)
    func NewWaitingRoomEvent(ctx *Context, name string, args WaitingRoomEventArgs, opts ...ResourceOption) (*WaitingRoomEvent, error)
    public WaitingRoomEvent(string name, WaitingRoomEventArgs args, CustomResourceOptions? opts = null)
    public WaitingRoomEvent(String name, WaitingRoomEventArgs args)
    public WaitingRoomEvent(String name, WaitingRoomEventArgs args, CustomResourceOptions options)
    
    type: cloudflare:WaitingRoomEvent
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaitingRoomEventArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var waitingRoomEventResource = new Cloudflare.WaitingRoomEvent("waitingRoomEventResource", new()
    {
        Name = "string",
        ZoneId = "string",
        WaitingRoomId = "string",
        EventEndTime = "string",
        EventStartTime = "string",
        NewUsersPerMinute = 0,
        CustomPageHtml = "string",
        PrequeueStartTime = "string",
        QueueingMethod = "string",
        SessionDuration = 0,
        ShuffleAtEventStart = false,
        Suspended = false,
        TotalActiveUsers = 0,
        DisableSessionRenewal = false,
        Description = "string",
    });
    
    example, err := cloudflare.NewWaitingRoomEvent(ctx, "waitingRoomEventResource", &cloudflare.WaitingRoomEventArgs{
    	Name:                  pulumi.String("string"),
    	ZoneId:                pulumi.String("string"),
    	WaitingRoomId:         pulumi.String("string"),
    	EventEndTime:          pulumi.String("string"),
    	EventStartTime:        pulumi.String("string"),
    	NewUsersPerMinute:     pulumi.Int(0),
    	CustomPageHtml:        pulumi.String("string"),
    	PrequeueStartTime:     pulumi.String("string"),
    	QueueingMethod:        pulumi.String("string"),
    	SessionDuration:       pulumi.Int(0),
    	ShuffleAtEventStart:   pulumi.Bool(false),
    	Suspended:             pulumi.Bool(false),
    	TotalActiveUsers:      pulumi.Int(0),
    	DisableSessionRenewal: pulumi.Bool(false),
    	Description:           pulumi.String("string"),
    })
    
    var waitingRoomEventResource = new WaitingRoomEvent("waitingRoomEventResource", WaitingRoomEventArgs.builder()
        .name("string")
        .zoneId("string")
        .waitingRoomId("string")
        .eventEndTime("string")
        .eventStartTime("string")
        .newUsersPerMinute(0)
        .customPageHtml("string")
        .prequeueStartTime("string")
        .queueingMethod("string")
        .sessionDuration(0)
        .shuffleAtEventStart(false)
        .suspended(false)
        .totalActiveUsers(0)
        .disableSessionRenewal(false)
        .description("string")
        .build());
    
    waiting_room_event_resource = cloudflare.WaitingRoomEvent("waitingRoomEventResource",
        name="string",
        zone_id="string",
        waiting_room_id="string",
        event_end_time="string",
        event_start_time="string",
        new_users_per_minute=0,
        custom_page_html="string",
        prequeue_start_time="string",
        queueing_method="string",
        session_duration=0,
        shuffle_at_event_start=False,
        suspended=False,
        total_active_users=0,
        disable_session_renewal=False,
        description="string")
    
    const waitingRoomEventResource = new cloudflare.WaitingRoomEvent("waitingRoomEventResource", {
        name: "string",
        zoneId: "string",
        waitingRoomId: "string",
        eventEndTime: "string",
        eventStartTime: "string",
        newUsersPerMinute: 0,
        customPageHtml: "string",
        prequeueStartTime: "string",
        queueingMethod: "string",
        sessionDuration: 0,
        shuffleAtEventStart: false,
        suspended: false,
        totalActiveUsers: 0,
        disableSessionRenewal: false,
        description: "string",
    });
    
    type: cloudflare:WaitingRoomEvent
    properties:
        customPageHtml: string
        description: string
        disableSessionRenewal: false
        eventEndTime: string
        eventStartTime: string
        name: string
        newUsersPerMinute: 0
        prequeueStartTime: string
        queueingMethod: string
        sessionDuration: 0
        shuffleAtEventStart: false
        suspended: false
        totalActiveUsers: 0
        waitingRoomId: string
        zoneId: string
    

    WaitingRoomEvent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WaitingRoomEvent resource accepts the following input properties:

    EventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    EventStartTime string
    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.
    Name string
    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.
    WaitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CustomPageHtml string
    This is a templated html file that will be rendered at the edge.
    Description string
    A description to let users add more details about the event.
    DisableSessionRenewal bool
    Disables automatic renewal of session cookies.
    NewUsersPerMinute int
    The number of new users that will be let into the route every minute.
    PrequeueStartTime string
    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.
    QueueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    SessionDuration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    ShuffleAtEventStart bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    Suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    The total number of active user sessions on the route at a point in time.
    EventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    EventStartTime string
    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.
    Name string
    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.
    WaitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CustomPageHtml string
    This is a templated html file that will be rendered at the edge.
    Description string
    A description to let users add more details about the event.
    DisableSessionRenewal bool
    Disables automatic renewal of session cookies.
    NewUsersPerMinute int
    The number of new users that will be let into the route every minute.
    PrequeueStartTime string
    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.
    QueueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    SessionDuration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    ShuffleAtEventStart bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    Suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    The total number of active user sessions on the route at a point in time.
    eventEndTime String
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime String
    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.
    name String
    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.
    waitingRoomId String
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customPageHtml String
    This is a templated html file that will be rendered at the edge.
    description String
    A description to let users add more details about the event.
    disableSessionRenewal Boolean
    Disables automatic renewal of session cookies.
    newUsersPerMinute Integer
    The number of new users that will be let into the route every minute.
    prequeueStartTime String
    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.
    queueingMethod String
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration Integer
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart Boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended Boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Integer
    The total number of active user sessions on the route at a point in time.
    eventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime string
    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.
    name string
    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.
    waitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customPageHtml string
    This is a templated html file that will be rendered at the edge.
    description string
    A description to let users add more details about the event.
    disableSessionRenewal boolean
    Disables automatic renewal of session cookies.
    newUsersPerMinute number
    The number of new users that will be let into the route every minute.
    prequeueStartTime string
    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.
    queueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration number
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers number
    The total number of active user sessions on the route at a point in time.
    event_end_time str
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    event_start_time 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.
    name 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.
    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 bool
    Disables automatic renewal of session cookies.
    new_users_per_minute int
    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. Must occur at least 5 minutes before event_start_time.
    queueing_method str
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    session_duration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffle_at_event_start bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    total_active_users int
    The total number of active user sessions on the route at a point in time.
    eventEndTime String
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime String
    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.
    name String
    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.
    waitingRoomId String
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    customPageHtml String
    This is a templated html file that will be rendered at the edge.
    description String
    A description to let users add more details about the event.
    disableSessionRenewal Boolean
    Disables automatic renewal of session cookies.
    newUsersPerMinute Number
    The number of new users that will be let into the route every minute.
    prequeueStartTime String
    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.
    queueingMethod String
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration Number
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart Boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended Boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Number
    The total number of active user sessions on the route at a point in time.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WaitingRoomEvent resource produces the following output properties:

    CreatedOn string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Last modified time.
    CreatedOn string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Last modified time.
    createdOn String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    Last modified time.
    createdOn string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    Last modified time.
    created_on str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    Last modified time.
    createdOn String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    Last modified time.

    Look up Existing WaitingRoomEvent Resource

    Get an existing WaitingRoomEvent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WaitingRoomEventState, opts?: CustomResourceOptions): WaitingRoomEvent
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_on: Optional[str] = None,
            custom_page_html: Optional[str] = None,
            description: Optional[str] = None,
            disable_session_renewal: Optional[bool] = None,
            event_end_time: Optional[str] = None,
            event_start_time: Optional[str] = None,
            modified_on: Optional[str] = None,
            name: Optional[str] = None,
            new_users_per_minute: Optional[int] = None,
            prequeue_start_time: Optional[str] = None,
            queueing_method: Optional[str] = None,
            session_duration: Optional[int] = None,
            shuffle_at_event_start: Optional[bool] = None,
            suspended: Optional[bool] = None,
            total_active_users: Optional[int] = None,
            waiting_room_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> WaitingRoomEvent
    func GetWaitingRoomEvent(ctx *Context, name string, id IDInput, state *WaitingRoomEventState, opts ...ResourceOption) (*WaitingRoomEvent, error)
    public static WaitingRoomEvent Get(string name, Input<string> id, WaitingRoomEventState? state, CustomResourceOptions? opts = null)
    public static WaitingRoomEvent get(String name, Output<String> id, WaitingRoomEventState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedOn string
    Creation time.
    CustomPageHtml string
    This is a templated html file that will be rendered at the edge.
    Description string
    A description to let users add more details about the event.
    DisableSessionRenewal bool
    Disables automatic renewal of session cookies.
    EventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    EventStartTime string
    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.
    ModifiedOn string
    Last modified time.
    Name string
    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.
    NewUsersPerMinute int
    The number of new users that will be let into the route every minute.
    PrequeueStartTime string
    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.
    QueueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    SessionDuration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    ShuffleAtEventStart bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    Suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    The total number of active user sessions on the route at a point in time.
    WaitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    CreatedOn string
    Creation time.
    CustomPageHtml string
    This is a templated html file that will be rendered at the edge.
    Description string
    A description to let users add more details about the event.
    DisableSessionRenewal bool
    Disables automatic renewal of session cookies.
    EventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    EventStartTime string
    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.
    ModifiedOn string
    Last modified time.
    Name string
    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.
    NewUsersPerMinute int
    The number of new users that will be let into the route every minute.
    PrequeueStartTime string
    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.
    QueueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    SessionDuration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    ShuffleAtEventStart bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    Suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    TotalActiveUsers int
    The total number of active user sessions on the route at a point in time.
    WaitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    createdOn String
    Creation time.
    customPageHtml String
    This is a templated html file that will be rendered at the edge.
    description String
    A description to let users add more details about the event.
    disableSessionRenewal Boolean
    Disables automatic renewal of session cookies.
    eventEndTime String
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime String
    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.
    modifiedOn String
    Last modified time.
    name String
    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.
    newUsersPerMinute Integer
    The number of new users that will be let into the route every minute.
    prequeueStartTime String
    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.
    queueingMethod String
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration Integer
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart Boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended Boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Integer
    The total number of active user sessions on the route at a point in time.
    waitingRoomId String
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    createdOn string
    Creation time.
    customPageHtml string
    This is a templated html file that will be rendered at the edge.
    description string
    A description to let users add more details about the event.
    disableSessionRenewal boolean
    Disables automatic renewal of session cookies.
    eventEndTime string
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime string
    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.
    modifiedOn string
    Last modified time.
    name string
    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.
    newUsersPerMinute number
    The number of new users that will be let into the route every minute.
    prequeueStartTime string
    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.
    queueingMethod string
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration number
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers number
    The total number of active user sessions on the route at a point in time.
    waitingRoomId string
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    created_on str
    Creation time.
    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 bool
    Disables automatic renewal of session cookies.
    event_end_time str
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    event_start_time 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.
    modified_on str
    Last modified time.
    name 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.
    new_users_per_minute int
    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. Must occur at least 5 minutes before event_start_time.
    queueing_method str
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    session_duration int
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffle_at_event_start bool
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended bool
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    total_active_users int
    The total number of active user sessions on the route at a point in time.
    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.
    createdOn String
    Creation time.
    customPageHtml String
    This is a templated html file that will be rendered at the edge.
    description String
    A description to let users add more details about the event.
    disableSessionRenewal Boolean
    Disables automatic renewal of session cookies.
    eventEndTime String
    ISO 8601 timestamp that marks the end of the event. Modifying this attribute will force creation of a new resource.
    eventStartTime String
    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.
    modifiedOn String
    Last modified time.
    name String
    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.
    newUsersPerMinute Number
    The number of new users that will be let into the route every minute.
    prequeueStartTime String
    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.
    queueingMethod String
    The queueing method used by the waiting room. Available values: fifo, random, passthrough, reject.
    sessionDuration Number
    Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the origin.
    shuffleAtEventStart Boolean
    Users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. Defaults to false.
    suspended Boolean
    If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
    totalActiveUsers Number
    The total number of active user sessions on the route at a point in time.
    waitingRoomId String
    The Waiting Room ID the event should apply to. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

    Import

    Use the Zone ID, Waiting Room ID, and Event ID to import.

    $ pulumi import cloudflare:index/waitingRoomEvent:WaitingRoomEvent default <zone_id>/<waiting_room_id>/<waiting_room_event_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi