1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. esa
  5. WaitingRoomEvent
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.esa.WaitingRoomEvent

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

    Provides a ESA Waiting Room Event resource.

    For information about ESA Waiting Room Event and how to use it, see What is Waiting Room Event.

    NOTE: Available since v1.244.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const _default = alicloud.esa.getSites({
        planSubscribeType: "enterpriseplan",
    });
    const defaultSite = new alicloud.esa.Site("default", {
        siteName: "chenxin0116.site",
        instanceId: _default.then(_default => _default.sites?.[0]?.instanceId),
        coverage: "overseas",
        accessType: "NS",
    });
    const defaultWaitingRoom = new alicloud.esa.WaitingRoom("default", {
        status: "off",
        siteId: defaultSite.id,
        jsonResponseEnable: "off",
        description: "example",
        waitingRoomType: "default",
        disableSessionRenewalEnable: "off",
        cookieName: "__aliwaitingroom_example",
        waitingRoomName: "waitingroom_example",
        queueAllEnable: "off",
        queuingStatusCode: "200",
        customPageHtml: "",
        newUsersPerMinute: "200",
        sessionDuration: "5",
        language: "zhcn",
        totalActiveUsers: "300",
        queuingMethod: "fifo",
        hostNameAndPaths: [{
            domain: "sub_domain.com",
            path: "/example",
            subdomain: "example_sub_domain.com.",
        }],
    });
    const defaultWaitingRoomEvent = new alicloud.esa.WaitingRoomEvent("default", {
        waitingRoomId: defaultWaitingRoom.waitingRoomId,
        endTime: "1719863200",
        waitingRoomEventName: "WaitingRoomEvent_example",
        preQueueStartTime: "",
        randomPreQueueEnable: "off",
        jsonResponseEnable: "off",
        siteId: defaultSite.id,
        preQueueEnable: "off",
        description: "example",
        newUsersPerMinute: "200",
        queuingStatusCode: "200",
        customPageHtml: "",
        language: "zhcn",
        totalActiveUsers: "300",
        waitingRoomType: "default",
        startTime: "1719763200",
        status: "off",
        disableSessionRenewalEnable: "off",
        queuingMethod: "fifo",
        sessionDuration: "5",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
    default_site = alicloud.esa.Site("default",
        site_name="chenxin0116.site",
        instance_id=default.sites[0].instance_id,
        coverage="overseas",
        access_type="NS")
    default_waiting_room = alicloud.esa.WaitingRoom("default",
        status="off",
        site_id=default_site.id,
        json_response_enable="off",
        description="example",
        waiting_room_type="default",
        disable_session_renewal_enable="off",
        cookie_name="__aliwaitingroom_example",
        waiting_room_name="waitingroom_example",
        queue_all_enable="off",
        queuing_status_code="200",
        custom_page_html="",
        new_users_per_minute="200",
        session_duration="5",
        language="zhcn",
        total_active_users="300",
        queuing_method="fifo",
        host_name_and_paths=[{
            "domain": "sub_domain.com",
            "path": "/example",
            "subdomain": "example_sub_domain.com.",
        }])
    default_waiting_room_event = alicloud.esa.WaitingRoomEvent("default",
        waiting_room_id=default_waiting_room.waiting_room_id,
        end_time="1719863200",
        waiting_room_event_name="WaitingRoomEvent_example",
        pre_queue_start_time="",
        random_pre_queue_enable="off",
        json_response_enable="off",
        site_id=default_site.id,
        pre_queue_enable="off",
        description="example",
        new_users_per_minute="200",
        queuing_status_code="200",
        custom_page_html="",
        language="zhcn",
        total_active_users="300",
        waiting_room_type="default",
        start_time="1719763200",
        status="off",
        disable_session_renewal_enable="off",
        queuing_method="fifo",
        session_duration="5")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/esa"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_default, err := esa.GetSites(ctx, &esa.GetSitesArgs{
    			PlanSubscribeType: pulumi.StringRef("enterpriseplan"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultSite, err := esa.NewSite(ctx, "default", &esa.SiteArgs{
    			SiteName:   pulumi.String("chenxin0116.site"),
    			InstanceId: pulumi.String(_default.Sites[0].InstanceId),
    			Coverage:   pulumi.String("overseas"),
    			AccessType: pulumi.String("NS"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultWaitingRoom, err := esa.NewWaitingRoom(ctx, "default", &esa.WaitingRoomArgs{
    			Status:                      pulumi.String("off"),
    			SiteId:                      defaultSite.ID(),
    			JsonResponseEnable:          pulumi.String("off"),
    			Description:                 pulumi.String("example"),
    			WaitingRoomType:             pulumi.String("default"),
    			DisableSessionRenewalEnable: pulumi.String("off"),
    			CookieName:                  pulumi.String("__aliwaitingroom_example"),
    			WaitingRoomName:             pulumi.String("waitingroom_example"),
    			QueueAllEnable:              pulumi.String("off"),
    			QueuingStatusCode:           pulumi.String("200"),
    			CustomPageHtml:              pulumi.String(""),
    			NewUsersPerMinute:           pulumi.String("200"),
    			SessionDuration:             pulumi.String("5"),
    			Language:                    pulumi.String("zhcn"),
    			TotalActiveUsers:            pulumi.String("300"),
    			QueuingMethod:               pulumi.String("fifo"),
    			HostNameAndPaths: esa.WaitingRoomHostNameAndPathArray{
    				&esa.WaitingRoomHostNameAndPathArgs{
    					Domain:    pulumi.String("sub_domain.com"),
    					Path:      pulumi.String("/example"),
    					Subdomain: pulumi.String("example_sub_domain.com."),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = esa.NewWaitingRoomEvent(ctx, "default", &esa.WaitingRoomEventArgs{
    			WaitingRoomId:               defaultWaitingRoom.WaitingRoomId,
    			EndTime:                     pulumi.String("1719863200"),
    			WaitingRoomEventName:        pulumi.String("WaitingRoomEvent_example"),
    			PreQueueStartTime:           pulumi.String(""),
    			RandomPreQueueEnable:        pulumi.String("off"),
    			JsonResponseEnable:          pulumi.String("off"),
    			SiteId:                      defaultSite.ID(),
    			PreQueueEnable:              pulumi.String("off"),
    			Description:                 pulumi.String("example"),
    			NewUsersPerMinute:           pulumi.String("200"),
    			QueuingStatusCode:           pulumi.String("200"),
    			CustomPageHtml:              pulumi.String(""),
    			Language:                    pulumi.String("zhcn"),
    			TotalActiveUsers:            pulumi.String("300"),
    			WaitingRoomType:             pulumi.String("default"),
    			StartTime:                   pulumi.String("1719763200"),
    			Status:                      pulumi.String("off"),
    			DisableSessionRenewalEnable: pulumi.String("off"),
    			QueuingMethod:               pulumi.String("fifo"),
    			SessionDuration:             pulumi.String("5"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = AliCloud.Esa.GetSites.Invoke(new()
        {
            PlanSubscribeType = "enterpriseplan",
        });
    
        var defaultSite = new AliCloud.Esa.Site("default", new()
        {
            SiteName = "chenxin0116.site",
            InstanceId = @default.Apply(@default => @default.Apply(getSitesResult => getSitesResult.Sites[0]?.InstanceId)),
            Coverage = "overseas",
            AccessType = "NS",
        });
    
        var defaultWaitingRoom = new AliCloud.Esa.WaitingRoom("default", new()
        {
            Status = "off",
            SiteId = defaultSite.Id,
            JsonResponseEnable = "off",
            Description = "example",
            WaitingRoomType = "default",
            DisableSessionRenewalEnable = "off",
            CookieName = "__aliwaitingroom_example",
            WaitingRoomName = "waitingroom_example",
            QueueAllEnable = "off",
            QueuingStatusCode = "200",
            CustomPageHtml = "",
            NewUsersPerMinute = "200",
            SessionDuration = "5",
            Language = "zhcn",
            TotalActiveUsers = "300",
            QueuingMethod = "fifo",
            HostNameAndPaths = new[]
            {
                new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
                {
                    Domain = "sub_domain.com",
                    Path = "/example",
                    Subdomain = "example_sub_domain.com.",
                },
            },
        });
    
        var defaultWaitingRoomEvent = new AliCloud.Esa.WaitingRoomEvent("default", new()
        {
            WaitingRoomId = defaultWaitingRoom.WaitingRoomId,
            EndTime = "1719863200",
            WaitingRoomEventName = "WaitingRoomEvent_example",
            PreQueueStartTime = "",
            RandomPreQueueEnable = "off",
            JsonResponseEnable = "off",
            SiteId = defaultSite.Id,
            PreQueueEnable = "off",
            Description = "example",
            NewUsersPerMinute = "200",
            QueuingStatusCode = "200",
            CustomPageHtml = "",
            Language = "zhcn",
            TotalActiveUsers = "300",
            WaitingRoomType = "default",
            StartTime = "1719763200",
            Status = "off",
            DisableSessionRenewalEnable = "off",
            QueuingMethod = "fifo",
            SessionDuration = "5",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.esa.EsaFunctions;
    import com.pulumi.alicloud.esa.inputs.GetSitesArgs;
    import com.pulumi.alicloud.esa.Site;
    import com.pulumi.alicloud.esa.SiteArgs;
    import com.pulumi.alicloud.esa.WaitingRoom;
    import com.pulumi.alicloud.esa.WaitingRoomArgs;
    import com.pulumi.alicloud.esa.inputs.WaitingRoomHostNameAndPathArgs;
    import com.pulumi.alicloud.esa.WaitingRoomEvent;
    import com.pulumi.alicloud.esa.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) {
            final var default = EsaFunctions.getSites(GetSitesArgs.builder()
                .planSubscribeType("enterpriseplan")
                .build());
    
            var defaultSite = new Site("defaultSite", SiteArgs.builder()
                .siteName("chenxin0116.site")
                .instanceId(default_.sites()[0].instanceId())
                .coverage("overseas")
                .accessType("NS")
                .build());
    
            var defaultWaitingRoom = new WaitingRoom("defaultWaitingRoom", WaitingRoomArgs.builder()
                .status("off")
                .siteId(defaultSite.id())
                .jsonResponseEnable("off")
                .description("example")
                .waitingRoomType("default")
                .disableSessionRenewalEnable("off")
                .cookieName("__aliwaitingroom_example")
                .waitingRoomName("waitingroom_example")
                .queueAllEnable("off")
                .queuingStatusCode("200")
                .customPageHtml("")
                .newUsersPerMinute("200")
                .sessionDuration("5")
                .language("zhcn")
                .totalActiveUsers("300")
                .queuingMethod("fifo")
                .hostNameAndPaths(WaitingRoomHostNameAndPathArgs.builder()
                    .domain("sub_domain.com")
                    .path("/example")
                    .subdomain("example_sub_domain.com.")
                    .build())
                .build());
    
            var defaultWaitingRoomEvent = new WaitingRoomEvent("defaultWaitingRoomEvent", WaitingRoomEventArgs.builder()
                .waitingRoomId(defaultWaitingRoom.waitingRoomId())
                .endTime("1719863200")
                .waitingRoomEventName("WaitingRoomEvent_example")
                .preQueueStartTime("")
                .randomPreQueueEnable("off")
                .jsonResponseEnable("off")
                .siteId(defaultSite.id())
                .preQueueEnable("off")
                .description("example")
                .newUsersPerMinute("200")
                .queuingStatusCode("200")
                .customPageHtml("")
                .language("zhcn")
                .totalActiveUsers("300")
                .waitingRoomType("default")
                .startTime("1719763200")
                .status("off")
                .disableSessionRenewalEnable("off")
                .queuingMethod("fifo")
                .sessionDuration("5")
                .build());
    
        }
    }
    
    resources:
      defaultSite:
        type: alicloud:esa:Site
        name: default
        properties:
          siteName: chenxin0116.site
          instanceId: ${default.sites[0].instanceId}
          coverage: overseas
          accessType: NS
      defaultWaitingRoom:
        type: alicloud:esa:WaitingRoom
        name: default
        properties:
          status: off
          siteId: ${defaultSite.id}
          jsonResponseEnable: off
          description: example
          waitingRoomType: default
          disableSessionRenewalEnable: off
          cookieName: __aliwaitingroom_example
          waitingRoomName: waitingroom_example
          queueAllEnable: off
          queuingStatusCode: '200'
          customPageHtml: ""
          newUsersPerMinute: '200'
          sessionDuration: '5'
          language: zhcn
          totalActiveUsers: '300'
          queuingMethod: fifo
          hostNameAndPaths:
            - domain: sub_domain.com
              path: /example
              subdomain: example_sub_domain.com.
      defaultWaitingRoomEvent:
        type: alicloud:esa:WaitingRoomEvent
        name: default
        properties:
          waitingRoomId: ${defaultWaitingRoom.waitingRoomId}
          endTime: '1719863200'
          waitingRoomEventName: WaitingRoomEvent_example
          preQueueStartTime: ""
          randomPreQueueEnable: off
          jsonResponseEnable: off
          siteId: ${defaultSite.id}
          preQueueEnable: off
          description: example
          newUsersPerMinute: '200'
          queuingStatusCode: '200'
          customPageHtml: ""
          language: zhcn
          totalActiveUsers: '300'
          waitingRoomType: default
          startTime: '1719763200'
          status: off
          disableSessionRenewalEnable: off
          queuingMethod: fifo
          sessionDuration: '5'
    variables:
      default:
        fn::invoke:
          function: alicloud:esa:getSites
          arguments:
            planSubscribeType: enterpriseplan
    

    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,
                         status: Optional[str] = None,
                         queuing_status_code: Optional[str] = None,
                         waiting_room_type: Optional[str] = None,
                         end_time: Optional[str] = None,
                         waiting_room_event_name: Optional[str] = None,
                         total_active_users: Optional[str] = None,
                         new_users_per_minute: Optional[str] = None,
                         start_time: Optional[str] = None,
                         queuing_method: Optional[str] = None,
                         site_id: Optional[int] = None,
                         session_duration: Optional[str] = None,
                         language: Optional[str] = None,
                         random_pre_queue_enable: Optional[str] = None,
                         description: Optional[str] = None,
                         pre_queue_enable: Optional[str] = None,
                         custom_page_html: Optional[str] = None,
                         pre_queue_start_time: Optional[str] = None,
                         json_response_enable: Optional[str] = None,
                         waiting_room_id: Optional[str] = None,
                         disable_session_renewal_enable: 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: alicloud:esa: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 AliCloud.Esa.WaitingRoomEvent("waitingRoomEventResource", new()
    {
        Status = "string",
        QueuingStatusCode = "string",
        WaitingRoomType = "string",
        EndTime = "string",
        WaitingRoomEventName = "string",
        TotalActiveUsers = "string",
        NewUsersPerMinute = "string",
        StartTime = "string",
        QueuingMethod = "string",
        SiteId = 0,
        SessionDuration = "string",
        Language = "string",
        RandomPreQueueEnable = "string",
        Description = "string",
        PreQueueEnable = "string",
        CustomPageHtml = "string",
        PreQueueStartTime = "string",
        JsonResponseEnable = "string",
        WaitingRoomId = "string",
        DisableSessionRenewalEnable = "string",
    });
    
    example, err := esa.NewWaitingRoomEvent(ctx, "waitingRoomEventResource", &esa.WaitingRoomEventArgs{
    	Status:                      pulumi.String("string"),
    	QueuingStatusCode:           pulumi.String("string"),
    	WaitingRoomType:             pulumi.String("string"),
    	EndTime:                     pulumi.String("string"),
    	WaitingRoomEventName:        pulumi.String("string"),
    	TotalActiveUsers:            pulumi.String("string"),
    	NewUsersPerMinute:           pulumi.String("string"),
    	StartTime:                   pulumi.String("string"),
    	QueuingMethod:               pulumi.String("string"),
    	SiteId:                      pulumi.Int(0),
    	SessionDuration:             pulumi.String("string"),
    	Language:                    pulumi.String("string"),
    	RandomPreQueueEnable:        pulumi.String("string"),
    	Description:                 pulumi.String("string"),
    	PreQueueEnable:              pulumi.String("string"),
    	CustomPageHtml:              pulumi.String("string"),
    	PreQueueStartTime:           pulumi.String("string"),
    	JsonResponseEnable:          pulumi.String("string"),
    	WaitingRoomId:               pulumi.String("string"),
    	DisableSessionRenewalEnable: pulumi.String("string"),
    })
    
    var waitingRoomEventResource = new WaitingRoomEvent("waitingRoomEventResource", WaitingRoomEventArgs.builder()
        .status("string")
        .queuingStatusCode("string")
        .waitingRoomType("string")
        .endTime("string")
        .waitingRoomEventName("string")
        .totalActiveUsers("string")
        .newUsersPerMinute("string")
        .startTime("string")
        .queuingMethod("string")
        .siteId(0)
        .sessionDuration("string")
        .language("string")
        .randomPreQueueEnable("string")
        .description("string")
        .preQueueEnable("string")
        .customPageHtml("string")
        .preQueueStartTime("string")
        .jsonResponseEnable("string")
        .waitingRoomId("string")
        .disableSessionRenewalEnable("string")
        .build());
    
    waiting_room_event_resource = alicloud.esa.WaitingRoomEvent("waitingRoomEventResource",
        status="string",
        queuing_status_code="string",
        waiting_room_type="string",
        end_time="string",
        waiting_room_event_name="string",
        total_active_users="string",
        new_users_per_minute="string",
        start_time="string",
        queuing_method="string",
        site_id=0,
        session_duration="string",
        language="string",
        random_pre_queue_enable="string",
        description="string",
        pre_queue_enable="string",
        custom_page_html="string",
        pre_queue_start_time="string",
        json_response_enable="string",
        waiting_room_id="string",
        disable_session_renewal_enable="string")
    
    const waitingRoomEventResource = new alicloud.esa.WaitingRoomEvent("waitingRoomEventResource", {
        status: "string",
        queuingStatusCode: "string",
        waitingRoomType: "string",
        endTime: "string",
        waitingRoomEventName: "string",
        totalActiveUsers: "string",
        newUsersPerMinute: "string",
        startTime: "string",
        queuingMethod: "string",
        siteId: 0,
        sessionDuration: "string",
        language: "string",
        randomPreQueueEnable: "string",
        description: "string",
        preQueueEnable: "string",
        customPageHtml: "string",
        preQueueStartTime: "string",
        jsonResponseEnable: "string",
        waitingRoomId: "string",
        disableSessionRenewalEnable: "string",
    });
    
    type: alicloud:esa:WaitingRoomEvent
    properties:
        customPageHtml: string
        description: string
        disableSessionRenewalEnable: string
        endTime: string
        jsonResponseEnable: string
        language: string
        newUsersPerMinute: string
        preQueueEnable: string
        preQueueStartTime: string
        queuingMethod: string
        queuingStatusCode: string
        randomPreQueueEnable: string
        sessionDuration: string
        siteId: 0
        startTime: string
        status: string
        totalActiveUsers: string
        waitingRoomEventName: string
        waitingRoomId: string
        waitingRoomType: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WaitingRoomEvent resource accepts the following input properties:

    EndTime string
    The timestamp of the end time of the event.
    NewUsersPerMinute string
    Number of new users per minute.
    QueuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    QueuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    SessionDuration string
    User session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    StartTime string
    The timestamp of the event start time.
    Status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomEventName string
    Event name, custom event description.
    WaitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    CustomPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    Description string
    Waiting room description.
    DisableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    JsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    Language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    PreQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    PreQueueStartTime string
    Pre-queue start time.
    RandomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    WaitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    EndTime string
    The timestamp of the end time of the event.
    NewUsersPerMinute string
    Number of new users per minute.
    QueuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    QueuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    SessionDuration string
    User session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    StartTime string
    The timestamp of the event start time.
    Status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomEventName string
    Event name, custom event description.
    WaitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    CustomPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    Description string
    Waiting room description.
    DisableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    JsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    Language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    PreQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    PreQueueStartTime string
    Pre-queue start time.
    RandomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    WaitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    endTime String
    The timestamp of the end time of the event.
    newUsersPerMinute String
    Number of new users per minute.
    queuingMethod String
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode String
    Waiting room status code. Value: -'200' -'202' -'429'
    sessionDuration String
    User session duration in minutes.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites API.
    startTime String
    The timestamp of the event start time.
    status String
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers String
    Total number of active users.
    waitingRoomEventName String
    Event name, custom event description.
    waitingRoomType String
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml String
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description String
    Waiting room description.
    disableSessionRenewalEnable String
    Disable session renewal. Value: -'on': open. -'off': closed.
    jsonResponseEnable String
    JSON response switch. Value: -'on': open. -'off': closed.
    language String
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    preQueueEnable String
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime String
    Pre-queue start time.
    randomPreQueueEnable String
    Random queue switch. -'on': open. -'off': closed.
    waitingRoomId String
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    endTime string
    The timestamp of the end time of the event.
    newUsersPerMinute string
    Number of new users per minute.
    queuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    sessionDuration string
    User session duration in minutes.
    siteId number
    The site ID, which can be obtained by calling the ListSites API.
    startTime string
    The timestamp of the event start time.
    status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers string
    Total number of active users.
    waitingRoomEventName string
    Event name, custom event description.
    waitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description string
    Waiting room description.
    disableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    jsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    preQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime string
    Pre-queue start time.
    randomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    waitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    end_time str
    The timestamp of the end time of the event.
    new_users_per_minute str
    Number of new users per minute.
    queuing_method str
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuing_status_code str
    Waiting room status code. Value: -'200' -'202' -'429'
    session_duration str
    User session duration in minutes.
    site_id int
    The site ID, which can be obtained by calling the ListSites API.
    start_time str
    The timestamp of the event start time.
    status str
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    total_active_users str
    Total number of active users.
    waiting_room_event_name str
    Event name, custom event description.
    waiting_room_type str
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    custom_page_html str
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description str
    Waiting room description.
    disable_session_renewal_enable str
    Disable session renewal. Value: -'on': open. -'off': closed.
    json_response_enable str
    JSON response switch. Value: -'on': open. -'off': closed.
    language str
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    pre_queue_enable str
    Pre-queue switch. -'on': open. -'off': closed.
    pre_queue_start_time str
    Pre-queue start time.
    random_pre_queue_enable str
    Random queue switch. -'on': open. -'off': closed.
    waiting_room_id str
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    endTime String
    The timestamp of the end time of the event.
    newUsersPerMinute String
    Number of new users per minute.
    queuingMethod String
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode String
    Waiting room status code. Value: -'200' -'202' -'429'
    sessionDuration String
    User session duration in minutes.
    siteId Number
    The site ID, which can be obtained by calling the ListSites API.
    startTime String
    The timestamp of the event start time.
    status String
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers String
    Total number of active users.
    waitingRoomEventName String
    Event name, custom event description.
    waitingRoomType String
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml String
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description String
    Waiting room description.
    disableSessionRenewalEnable String
    Disable session renewal. Value: -'on': open. -'off': closed.
    jsonResponseEnable String
    JSON response switch. Value: -'on': open. -'off': closed.
    language String
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    preQueueEnable String
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime String
    Pre-queue start time.
    randomPreQueueEnable String
    Random queue switch. -'on': open. -'off': closed.
    waitingRoomId String
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    WaitingRoomEventId int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    Id string
    The provider-assigned unique ID for this managed resource.
    WaitingRoomEventId int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    id String
    The provider-assigned unique ID for this managed resource.
    waitingRoomEventId Integer
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    id string
    The provider-assigned unique ID for this managed resource.
    waitingRoomEventId number
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    id str
    The provider-assigned unique ID for this managed resource.
    waiting_room_event_id int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    id String
    The provider-assigned unique ID for this managed resource.
    waitingRoomEventId Number
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.

    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,
            custom_page_html: Optional[str] = None,
            description: Optional[str] = None,
            disable_session_renewal_enable: Optional[str] = None,
            end_time: Optional[str] = None,
            json_response_enable: Optional[str] = None,
            language: Optional[str] = None,
            new_users_per_minute: Optional[str] = None,
            pre_queue_enable: Optional[str] = None,
            pre_queue_start_time: Optional[str] = None,
            queuing_method: Optional[str] = None,
            queuing_status_code: Optional[str] = None,
            random_pre_queue_enable: Optional[str] = None,
            session_duration: Optional[str] = None,
            site_id: Optional[int] = None,
            start_time: Optional[str] = None,
            status: Optional[str] = None,
            total_active_users: Optional[str] = None,
            waiting_room_event_id: Optional[int] = None,
            waiting_room_event_name: Optional[str] = None,
            waiting_room_id: Optional[str] = None,
            waiting_room_type: 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)
    resources:  _:    type: alicloud:esa:WaitingRoomEvent    get:      id: ${id}
    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:
    CustomPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    Description string
    Waiting room description.
    DisableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    EndTime string
    The timestamp of the end time of the event.
    JsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    Language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    NewUsersPerMinute string
    Number of new users per minute.
    PreQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    PreQueueStartTime string
    Pre-queue start time.
    QueuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    QueuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    RandomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    SessionDuration string
    User session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    StartTime string
    The timestamp of the event start time.
    Status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomEventId int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    WaitingRoomEventName string
    Event name, custom event description.
    WaitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    WaitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    CustomPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    Description string
    Waiting room description.
    DisableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    EndTime string
    The timestamp of the end time of the event.
    JsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    Language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    NewUsersPerMinute string
    Number of new users per minute.
    PreQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    PreQueueStartTime string
    Pre-queue start time.
    QueuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    QueuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    RandomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    SessionDuration string
    User session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    StartTime string
    The timestamp of the event start time.
    Status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomEventId int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    WaitingRoomEventName string
    Event name, custom event description.
    WaitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    WaitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml String
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description String
    Waiting room description.
    disableSessionRenewalEnable String
    Disable session renewal. Value: -'on': open. -'off': closed.
    endTime String
    The timestamp of the end time of the event.
    jsonResponseEnable String
    JSON response switch. Value: -'on': open. -'off': closed.
    language String
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute String
    Number of new users per minute.
    preQueueEnable String
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime String
    Pre-queue start time.
    queuingMethod String
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode String
    Waiting room status code. Value: -'200' -'202' -'429'
    randomPreQueueEnable String
    Random queue switch. -'on': open. -'off': closed.
    sessionDuration String
    User session duration in minutes.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites API.
    startTime String
    The timestamp of the event start time.
    status String
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers String
    Total number of active users.
    waitingRoomEventId Integer
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    waitingRoomEventName String
    Event name, custom event description.
    waitingRoomId String
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    waitingRoomType String
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml string
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description string
    Waiting room description.
    disableSessionRenewalEnable string
    Disable session renewal. Value: -'on': open. -'off': closed.
    endTime string
    The timestamp of the end time of the event.
    jsonResponseEnable string
    JSON response switch. Value: -'on': open. -'off': closed.
    language string
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute string
    Number of new users per minute.
    preQueueEnable string
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime string
    Pre-queue start time.
    queuingMethod string
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode string
    Waiting room status code. Value: -'200' -'202' -'429'
    randomPreQueueEnable string
    Random queue switch. -'on': open. -'off': closed.
    sessionDuration string
    User session duration in minutes.
    siteId number
    The site ID, which can be obtained by calling the ListSites API.
    startTime string
    The timestamp of the event start time.
    status string
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers string
    Total number of active users.
    waitingRoomEventId number
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    waitingRoomEventName string
    Event name, custom event description.
    waitingRoomId string
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    waitingRoomType string
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    custom_page_html str
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description str
    Waiting room description.
    disable_session_renewal_enable str
    Disable session renewal. Value: -'on': open. -'off': closed.
    end_time str
    The timestamp of the end time of the event.
    json_response_enable str
    JSON response switch. Value: -'on': open. -'off': closed.
    language str
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    new_users_per_minute str
    Number of new users per minute.
    pre_queue_enable str
    Pre-queue switch. -'on': open. -'off': closed.
    pre_queue_start_time str
    Pre-queue start time.
    queuing_method str
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuing_status_code str
    Waiting room status code. Value: -'200' -'202' -'429'
    random_pre_queue_enable str
    Random queue switch. -'on': open. -'off': closed.
    session_duration str
    User session duration in minutes.
    site_id int
    The site ID, which can be obtained by calling the ListSites API.
    start_time str
    The timestamp of the event start time.
    status str
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    total_active_users str
    Total number of active users.
    waiting_room_event_id int
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    waiting_room_event_name str
    Event name, custom event description.
    waiting_room_id str
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    waiting_room_type str
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.
    customPageHtml String
    User-defined waiting room page content, when the waiting room type is custom type, you need to enter. The incoming content needs to be base64 encoded.
    description String
    Waiting room description.
    disableSessionRenewalEnable String
    Disable session renewal. Value: -'on': open. -'off': closed.
    endTime String
    The timestamp of the end time of the event.
    jsonResponseEnable String
    JSON response switch. Value: -'on': open. -'off': closed.
    language String
    Default language setting. Values include: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute String
    Number of new users per minute.
    preQueueEnable String
    Pre-queue switch. -'on': open. -'off': closed.
    preQueueStartTime String
    Pre-queue start time.
    queuingMethod String
    Way of queuing. Value: -'random': random. -'fifo': first in, first out. -'passthrough ': through. -'reject-all': reject all.
    queuingStatusCode String
    Waiting room status code. Value: -'200' -'202' -'429'
    randomPreQueueEnable String
    Random queue switch. -'on': open. -'off': closed.
    sessionDuration String
    User session duration in minutes.
    siteId Number
    The site ID, which can be obtained by calling the ListSites API.
    startTime String
    The timestamp of the event start time.
    status String
    Enabled status. Value: -'on': Enable waiting room events -'off': Disable waiting room events
    totalActiveUsers String
    Total number of active users.
    waitingRoomEventId Number
    The waiting room event ID, which can be obtained by calling the ListWaitingRoomEvents operation.
    waitingRoomEventName String
    Event name, custom event description.
    waitingRoomId String
    Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the listwaitingroom interface.
    waitingRoomType String
    Waiting room type. The following types are supported: -'default': the default type. -'custom': custom type.

    Import

    ESA Waiting Room Event can be imported using the id, e.g.

    $ pulumi import alicloud:esa/waitingRoomEvent:WaitingRoomEvent example <site_id>:<waiting_room_id>:<waiting_room_event_id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi