Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. esa
  5. WaitingRoom
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.esa.WaitingRoom

Explore with Pulumi AI

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

    Provides a ESA Waiting Room resource.

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

    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 resourceSiteExample = new alicloud.esa.Site("resource_Site_example", {
    siteName: "terraform.site",
    instanceId: _default.then(_default => _default.sites?.[0]?.instanceId),
    coverage: "overseas",
    accessType: "NS",
});
const defaultWaitingRoom = new alicloud.esa.WaitingRoom("default", {
    queuingMethod: "fifo",
    sessionDuration: "5",
    totalActiveUsers: "300",
    hostNameAndPaths: [
        {
            domain: "sub_domain.com",
            path: "/example",
            subdomain: "example_sub_domain.com.",
        },
        {
            domain: "sub_domain.com",
            path: "/example",
            subdomain: "example_sub_domain1.com.",
        },
        {
            path: "/example",
            subdomain: "example_sub_domain2.com.",
            domain: "sub_domain.com",
        },
    ],
    waitingRoomType: "default",
    newUsersPerMinute: "200",
    customPageHtml: "",
    language: "zhcn",
    queuingStatusCode: "200",
    waitingRoomName: "waitingroom_example",
    status: "off",
    siteId: resourceSiteExample.id,
    queueAllEnable: "off",
    disableSessionRenewalEnable: "off",
    description: "example",
    jsonResponseEnable: "off",
    cookieName: "__aliwaitingroom_example",
});

    import pulumi
import pulumi_alicloud as alicloud

default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
resource_site_example = alicloud.esa.Site("resource_Site_example",
    site_name="terraform.site",
    instance_id=default.sites[0].instance_id,
    coverage="overseas",
    access_type="NS")
default_waiting_room = alicloud.esa.WaitingRoom("default",
    queuing_method="fifo",
    session_duration="5",
    total_active_users="300",
    host_name_and_paths=[
        {
            "domain": "sub_domain.com",
            "path": "/example",
            "subdomain": "example_sub_domain.com.",
        },
        {
            "domain": "sub_domain.com",
            "path": "/example",
            "subdomain": "example_sub_domain1.com.",
        },
        {
            "path": "/example",
            "subdomain": "example_sub_domain2.com.",
            "domain": "sub_domain.com",
        },
    ],
    waiting_room_type="default",
    new_users_per_minute="200",
    custom_page_html="",
    language="zhcn",
    queuing_status_code="200",
    waiting_room_name="waitingroom_example",
    status="off",
    site_id=resource_site_example.id,
    queue_all_enable="off",
    disable_session_renewal_enable="off",
    description="example",
    json_response_enable="off",
    cookie_name="__aliwaitingroom_example")

    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
		}
		resourceSiteExample, err := esa.NewSite(ctx, "resource_Site_example", &esa.SiteArgs{
			SiteName:   pulumi.String("terraform.site"),
			InstanceId: pulumi.String(_default.Sites[0].InstanceId),
			Coverage:   pulumi.String("overseas"),
			AccessType: pulumi.String("NS"),
		})
		if err != nil {
			return err
		}
		_, err = esa.NewWaitingRoom(ctx, "default", &esa.WaitingRoomArgs{
			QueuingMethod:    pulumi.String("fifo"),
			SessionDuration:  pulumi.String("5"),
			TotalActiveUsers: pulumi.String("300"),
			HostNameAndPaths: esa.WaitingRoomHostNameAndPathArray{
				&esa.WaitingRoomHostNameAndPathArgs{
					Domain:    pulumi.String("sub_domain.com"),
					Path:      pulumi.String("/example"),
					Subdomain: pulumi.String("example_sub_domain.com."),
				},
				&esa.WaitingRoomHostNameAndPathArgs{
					Domain:    pulumi.String("sub_domain.com"),
					Path:      pulumi.String("/example"),
					Subdomain: pulumi.String("example_sub_domain1.com."),
				},
				&esa.WaitingRoomHostNameAndPathArgs{
					Path:      pulumi.String("/example"),
					Subdomain: pulumi.String("example_sub_domain2.com."),
					Domain:    pulumi.String("sub_domain.com"),
				},
			},
			WaitingRoomType:             pulumi.String("default"),
			NewUsersPerMinute:           pulumi.String("200"),
			CustomPageHtml:              pulumi.String(""),
			Language:                    pulumi.String("zhcn"),
			QueuingStatusCode:           pulumi.String("200"),
			WaitingRoomName:             pulumi.String("waitingroom_example"),
			Status:                      pulumi.String("off"),
			SiteId:                      resourceSiteExample.ID(),
			QueueAllEnable:              pulumi.String("off"),
			DisableSessionRenewalEnable: pulumi.String("off"),
			Description:                 pulumi.String("example"),
			JsonResponseEnable:          pulumi.String("off"),
			CookieName:                  pulumi.String("__aliwaitingroom_example"),
		})
		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 resourceSiteExample = new AliCloud.Esa.Site("resource_Site_example", new()
    {
        SiteName = "terraform.site",
        InstanceId = @default.Apply(@default => @default.Apply(getSitesResult => getSitesResult.Sites[0]?.InstanceId)),
        Coverage = "overseas",
        AccessType = "NS",
    });

    var defaultWaitingRoom = new AliCloud.Esa.WaitingRoom("default", new()
    {
        QueuingMethod = "fifo",
        SessionDuration = "5",
        TotalActiveUsers = "300",
        HostNameAndPaths = new[]
        {
            new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
            {
                Domain = "sub_domain.com",
                Path = "/example",
                Subdomain = "example_sub_domain.com.",
            },
            new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
            {
                Domain = "sub_domain.com",
                Path = "/example",
                Subdomain = "example_sub_domain1.com.",
            },
            new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
            {
                Path = "/example",
                Subdomain = "example_sub_domain2.com.",
                Domain = "sub_domain.com",
            },
        },
        WaitingRoomType = "default",
        NewUsersPerMinute = "200",
        CustomPageHtml = "",
        Language = "zhcn",
        QueuingStatusCode = "200",
        WaitingRoomName = "waitingroom_example",
        Status = "off",
        SiteId = resourceSiteExample.Id,
        QueueAllEnable = "off",
        DisableSessionRenewalEnable = "off",
        Description = "example",
        JsonResponseEnable = "off",
        CookieName = "__aliwaitingroom_example",
    });

});

    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 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 resourceSiteExample = new Site("resourceSiteExample", SiteArgs.builder()
            .siteName("terraform.site")
            .instanceId(default_.sites()[0].instanceId())
            .coverage("overseas")
            .accessType("NS")
            .build());

        var defaultWaitingRoom = new WaitingRoom("defaultWaitingRoom", WaitingRoomArgs.builder()
            .queuingMethod("fifo")
            .sessionDuration("5")
            .totalActiveUsers("300")
            .hostNameAndPaths(            
                WaitingRoomHostNameAndPathArgs.builder()
                    .domain("sub_domain.com")
                    .path("/example")
                    .subdomain("example_sub_domain.com.")
                    .build(),
                WaitingRoomHostNameAndPathArgs.builder()
                    .domain("sub_domain.com")
                    .path("/example")
                    .subdomain("example_sub_domain1.com.")
                    .build(),
                WaitingRoomHostNameAndPathArgs.builder()
                    .path("/example")
                    .subdomain("example_sub_domain2.com.")
                    .domain("sub_domain.com")
                    .build())
            .waitingRoomType("default")
            .newUsersPerMinute("200")
            .customPageHtml("")
            .language("zhcn")
            .queuingStatusCode("200")
            .waitingRoomName("waitingroom_example")
            .status("off")
            .siteId(resourceSiteExample.id())
            .queueAllEnable("off")
            .disableSessionRenewalEnable("off")
            .description("example")
            .jsonResponseEnable("off")
            .cookieName("__aliwaitingroom_example")
            .build());

    }
}

    resources:
  resourceSiteExample:
    type: alicloud:esa:Site
    name: resource_Site_example
    properties:
      siteName: terraform.site
      instanceId: ${default.sites[0].instanceId}
      coverage: overseas
      accessType: NS
  defaultWaitingRoom:
    type: alicloud:esa:WaitingRoom
    name: default
    properties:
      queuingMethod: fifo
      sessionDuration: '5'
      totalActiveUsers: '300'
      hostNameAndPaths:
        - domain: sub_domain.com
          path: /example
          subdomain: example_sub_domain.com.
        - domain: sub_domain.com
          path: /example
          subdomain: example_sub_domain1.com.
        - path: /example
          subdomain: example_sub_domain2.com.
          domain: sub_domain.com
      waitingRoomType: default
      newUsersPerMinute: '200'
      customPageHtml: ""
      language: zhcn
      queuingStatusCode: '200'
      waitingRoomName: waitingroom_example
      status: off
      siteId: ${resourceSiteExample.id}
      queueAllEnable: off
      disableSessionRenewalEnable: off
      description: example
      jsonResponseEnable: off
      cookieName: __aliwaitingroom_example
variables:
  default:
    fn::invoke:
      function: alicloud:esa:getSites
      arguments:
        planSubscribeType: enterpriseplan

    Create WaitingRoom Resource

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

    Constructor syntax

    new WaitingRoom(name: string, args: WaitingRoomArgs, opts?: CustomResourceOptions);
    @overload
def WaitingRoom(resource_name: str,
                args: WaitingRoomArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def WaitingRoom(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                site_id: Optional[int] = None,
                status: Optional[str] = None,
                waiting_room_type: Optional[str] = None,
                waiting_room_name: Optional[str] = None,
                host_name_and_paths: Optional[Sequence[WaitingRoomHostNameAndPathArgs]] = None,
                total_active_users: Optional[str] = None,
                queuing_status_code: Optional[str] = None,
                new_users_per_minute: Optional[str] = None,
                cookie_name: Optional[str] = None,
                queuing_method: Optional[str] = None,
                session_duration: Optional[str] = None,
                queue_all_enable: Optional[str] = None,
                custom_page_html: Optional[str] = None,
                language: Optional[str] = None,
                json_response_enable: Optional[str] = None,
                disable_session_renewal_enable: Optional[str] = None,
                description: Optional[str] = None)
    func NewWaitingRoom(ctx *Context, name string, args WaitingRoomArgs, opts ...ResourceOption) (*WaitingRoom, error)
    public WaitingRoom(string name, WaitingRoomArgs args, CustomResourceOptions? opts = null)
    public WaitingRoom(String name, WaitingRoomArgs args)
public WaitingRoom(String name, WaitingRoomArgs args, CustomResourceOptions options)

    type: alicloud:esa:WaitingRoom
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 WaitingRoomArgs
    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 WaitingRoomArgs
    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 WaitingRoomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaitingRoomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaitingRoomArgs
    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 waitingRoomResource = new AliCloud.Esa.WaitingRoom("waitingRoomResource", new()
{
    SiteId = 0,
    Status = "string",
    WaitingRoomType = "string",
    WaitingRoomName = "string",
    HostNameAndPaths = new[]
    {
        new AliCloud.Esa.Inputs.WaitingRoomHostNameAndPathArgs
        {
            Domain = "string",
            Path = "string",
            Subdomain = "string",
        },
    },
    TotalActiveUsers = "string",
    QueuingStatusCode = "string",
    NewUsersPerMinute = "string",
    CookieName = "string",
    QueuingMethod = "string",
    SessionDuration = "string",
    QueueAllEnable = "string",
    CustomPageHtml = "string",
    Language = "string",
    JsonResponseEnable = "string",
    DisableSessionRenewalEnable = "string",
    Description = "string",
});

    example, err := esa.NewWaitingRoom(ctx, "waitingRoomResource", &esa.WaitingRoomArgs{
	SiteId:          pulumi.Int(0),
	Status:          pulumi.String("string"),
	WaitingRoomType: pulumi.String("string"),
	WaitingRoomName: pulumi.String("string"),
	HostNameAndPaths: esa.WaitingRoomHostNameAndPathArray{
		&esa.WaitingRoomHostNameAndPathArgs{
			Domain:    pulumi.String("string"),
			Path:      pulumi.String("string"),
			Subdomain: pulumi.String("string"),
		},
	},
	TotalActiveUsers:            pulumi.String("string"),
	QueuingStatusCode:           pulumi.String("string"),
	NewUsersPerMinute:           pulumi.String("string"),
	CookieName:                  pulumi.String("string"),
	QueuingMethod:               pulumi.String("string"),
	SessionDuration:             pulumi.String("string"),
	QueueAllEnable:              pulumi.String("string"),
	CustomPageHtml:              pulumi.String("string"),
	Language:                    pulumi.String("string"),
	JsonResponseEnable:          pulumi.String("string"),
	DisableSessionRenewalEnable: pulumi.String("string"),
	Description:                 pulumi.String("string"),
})

    var waitingRoomResource = new WaitingRoom("waitingRoomResource", WaitingRoomArgs.builder()
    .siteId(0)
    .status("string")
    .waitingRoomType("string")
    .waitingRoomName("string")
    .hostNameAndPaths(WaitingRoomHostNameAndPathArgs.builder()
        .domain("string")
        .path("string")
        .subdomain("string")
        .build())
    .totalActiveUsers("string")
    .queuingStatusCode("string")
    .newUsersPerMinute("string")
    .cookieName("string")
    .queuingMethod("string")
    .sessionDuration("string")
    .queueAllEnable("string")
    .customPageHtml("string")
    .language("string")
    .jsonResponseEnable("string")
    .disableSessionRenewalEnable("string")
    .description("string")
    .build());

    waiting_room_resource = alicloud.esa.WaitingRoom("waitingRoomResource",
    site_id=0,
    status="string",
    waiting_room_type="string",
    waiting_room_name="string",
    host_name_and_paths=[{
        "domain": "string",
        "path": "string",
        "subdomain": "string",
    }],
    total_active_users="string",
    queuing_status_code="string",
    new_users_per_minute="string",
    cookie_name="string",
    queuing_method="string",
    session_duration="string",
    queue_all_enable="string",
    custom_page_html="string",
    language="string",
    json_response_enable="string",
    disable_session_renewal_enable="string",
    description="string")

    const waitingRoomResource = new alicloud.esa.WaitingRoom("waitingRoomResource", {
    siteId: 0,
    status: "string",
    waitingRoomType: "string",
    waitingRoomName: "string",
    hostNameAndPaths: [{
        domain: "string",
        path: "string",
        subdomain: "string",
    }],
    totalActiveUsers: "string",
    queuingStatusCode: "string",
    newUsersPerMinute: "string",
    cookieName: "string",
    queuingMethod: "string",
    sessionDuration: "string",
    queueAllEnable: "string",
    customPageHtml: "string",
    language: "string",
    jsonResponseEnable: "string",
    disableSessionRenewalEnable: "string",
    description: "string",
});

    type: alicloud:esa:WaitingRoom
properties:
    cookieName: string
    customPageHtml: string
    description: string
    disableSessionRenewalEnable: string
    hostNameAndPaths:
        - domain: string
          path: string
          subdomain: string
    jsonResponseEnable: string
    language: string
    newUsersPerMinute: string
    queueAllEnable: string
    queuingMethod: string
    queuingStatusCode: string
    sessionDuration: string
    siteId: 0
    status: string
    totalActiveUsers: string
    waitingRoomName: string
    waitingRoomType: string

    WaitingRoom 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 WaitingRoom resource accepts the following input properties:

    CookieName string
    Custom Cookie name.
    HostNameAndPaths List<Pulumi.AliCloud.Esa.Inputs.WaitingRoomHostNameAndPath>
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites interface.
    Status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomName string
    The name of the waiting room.
    WaitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    Language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    QueueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    CookieName string
    Custom Cookie name.
    HostNameAndPaths []WaitingRoomHostNameAndPathArgs
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites interface.
    Status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomName string
    The name of the waiting room.
    WaitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    Language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    QueueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    cookieName String
    Custom Cookie name.
    hostNameAndPaths List<WaitingRoomHostNameAndPath>
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites interface.
    status String
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers String
    Total number of active users.
    waitingRoomName String
    The name of the waiting room.
    waitingRoomType String
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language String
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    queueAllEnable String
    All in line. Value: -'on': open. -'off': closed.
    cookieName string
    Custom Cookie name.
    hostNameAndPaths WaitingRoomHostNameAndPath[]
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    siteId number
    The site ID, which can be obtained by calling the ListSites interface.
    status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers string
    Total number of active users.
    waitingRoomName string
    The name of the waiting room.
    waitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    queueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    cookie_name str
    Custom Cookie name.
    host_name_and_paths Sequence[WaitingRoomHostNameAndPathArgs]
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    site_id int
    The site ID, which can be obtained by calling the ListSites interface.
    status str
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    total_active_users str
    Total number of active users.
    waiting_room_name str
    The name of the waiting room.
    waiting_room_type str
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language str
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    queue_all_enable str
    All in line. Value: -'on': open. -'off': closed.
    cookieName String
    Custom Cookie name.
    hostNameAndPaths List<Property Map>
    Host name and path. See host_name_and_path below.
    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
    Session duration in minutes.
    siteId Number
    The site ID, which can be obtained by calling the ListSites interface.
    status String
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers String
    Total number of active users.
    waitingRoomName String
    The name of the waiting room.
    waitingRoomType String
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a 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
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language String
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    queueAllEnable String
    All in line. Value: -'on': open. -'off': closed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    WaitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    Id string
    The provider-assigned unique ID for this managed resource.
    WaitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    id String
    The provider-assigned unique ID for this managed resource.
    waitingRoomId String
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    id string
    The provider-assigned unique ID for this managed resource.
    waitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    id str
    The provider-assigned unique ID for this managed resource.
    waiting_room_id str
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    id String
    The provider-assigned unique ID for this managed resource.
    waitingRoomId String
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.

    Look up Existing WaitingRoom Resource

    Get an existing WaitingRoom 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?: WaitingRoomState, opts?: CustomResourceOptions): WaitingRoom
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cookie_name: Optional[str] = None,
        custom_page_html: Optional[str] = None,
        description: Optional[str] = None,
        disable_session_renewal_enable: Optional[str] = None,
        host_name_and_paths: Optional[Sequence[WaitingRoomHostNameAndPathArgs]] = None,
        json_response_enable: Optional[str] = None,
        language: Optional[str] = None,
        new_users_per_minute: Optional[str] = None,
        queue_all_enable: Optional[str] = None,
        queuing_method: Optional[str] = None,
        queuing_status_code: Optional[str] = None,
        session_duration: Optional[str] = None,
        site_id: Optional[int] = None,
        status: Optional[str] = None,
        total_active_users: Optional[str] = None,
        waiting_room_id: Optional[str] = None,
        waiting_room_name: Optional[str] = None,
        waiting_room_type: Optional[str] = None) -> WaitingRoom
    func GetWaitingRoom(ctx *Context, name string, id IDInput, state *WaitingRoomState, opts ...ResourceOption) (*WaitingRoom, error)
    public static WaitingRoom Get(string name, Input<string> id, WaitingRoomState? state, CustomResourceOptions? opts = null)
    public static WaitingRoom get(String name, Output<String> id, WaitingRoomState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:esa:WaitingRoom    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:
    CookieName string
    Custom Cookie name.
    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.
    HostNameAndPaths List<Pulumi.AliCloud.Esa.Inputs.WaitingRoomHostNameAndPath>
    Host name and path. See host_name_and_path below.
    JsonResponseEnable string
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    Language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    NewUsersPerMinute string
    Number of new users per minute.
    QueueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites interface.
    Status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    WaitingRoomName string
    The name of the waiting room.
    WaitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.
    CookieName string
    Custom Cookie name.
    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.
    HostNameAndPaths []WaitingRoomHostNameAndPathArgs
    Host name and path. See host_name_and_path below.
    JsonResponseEnable string
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    Language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    NewUsersPerMinute string
    Number of new users per minute.
    QueueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    SiteId int
    The site ID, which can be obtained by calling the ListSites interface.
    Status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    TotalActiveUsers string
    Total number of active users.
    WaitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    WaitingRoomName string
    The name of the waiting room.
    WaitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.
    cookieName String
    Custom Cookie name.
    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.
    hostNameAndPaths List<WaitingRoomHostNameAndPath>
    Host name and path. See host_name_and_path below.
    jsonResponseEnable String
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language String
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute String
    Number of new users per minute.
    queueAllEnable String
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites interface.
    status String
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers String
    Total number of active users.
    waitingRoomId String
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    waitingRoomName String
    The name of the waiting room.
    waitingRoomType String
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.
    cookieName string
    Custom Cookie name.
    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.
    hostNameAndPaths WaitingRoomHostNameAndPath[]
    Host name and path. See host_name_and_path below.
    jsonResponseEnable string
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language string
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute string
    Number of new users per minute.
    queueAllEnable string
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    siteId number
    The site ID, which can be obtained by calling the ListSites interface.
    status string
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers string
    Total number of active users.
    waitingRoomId string
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    waitingRoomName string
    The name of the waiting room.
    waitingRoomType string
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.
    cookie_name str
    Custom Cookie name.
    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.
    host_name_and_paths Sequence[WaitingRoomHostNameAndPathArgs]
    Host name and path. See host_name_and_path below.
    json_response_enable str
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language str
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    new_users_per_minute str
    Number of new users per minute.
    queue_all_enable str
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    site_id int
    The site ID, which can be obtained by calling the ListSites interface.
    status str
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    total_active_users str
    Total number of active users.
    waiting_room_id str
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    waiting_room_name str
    The name of the waiting room.
    waiting_room_type str
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.
    cookieName String
    Custom Cookie name.
    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.
    hostNameAndPaths List<Property Map>
    Host name and path. See host_name_and_path below.
    jsonResponseEnable String
    The JSON response. If the accept request header contains "application/json", JSON data is returned. Value: -'on': open. -'off': closed.
    language String
    The language of the waiting room page. When the waiting room type is the default type, it needs to be passed in. The following types are supported: -'enus': English. -'zhcn': Simplified Chinese. -'zhhk': Traditional Chinese.
    newUsersPerMinute String
    Number of new users per minute.
    queueAllEnable String
    All in line. Value: -'on': open. -'off': closed.
    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
    Session duration in minutes.
    siteId Number
    The site ID, which can be obtained by calling the ListSites interface.
    status String
    Waiting room enabled status. Value: -'on': Enable waiting room -'off': disabled waiting room
    totalActiveUsers String
    Total number of active users.
    waitingRoomId String
    The waiting room ID, which can be obtained by calling the ListWaitingRooms API.
    waitingRoomName String
    The name of the waiting room.
    waitingRoomType String
    Waiting room type, support: -'default': Indicates the default type. -'custom': indicates a custom type.

    Supporting Types

    WaitingRoomHostNameAndPath, WaitingRoomHostNameAndPathArgs

    Domain string
    The domain name.
    Path string
    The path.
    Subdomain string
    The subdomain.
    Domain string
    The domain name.
    Path string
    The path.
    Subdomain string
    The subdomain.
    domain String
    The domain name.
    path String
    The path.
    subdomain String
    The subdomain.
    domain string
    The domain name.
    path string
    The path.
    subdomain string
    The subdomain.
    domain str
    The domain name.
    path str
    The path.
    subdomain str
    The subdomain.
    domain String
    The domain name.
    path String
    The path.
    subdomain String
    The subdomain.

    Import

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

    $ pulumi import alicloud:esa/waitingRoom:WaitingRoom example <site_id>:<waiting_room_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
    pulumi/pulumi-alicloud