ALIYUN::ESA::WaitingRoomEvent-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::ESA::WaitingRoomEvent resource creates a waiting room event.

Syntax

{
  "Type": "ALIYUN::ESA::WaitingRoomEvent",
  "Properties": {
    "EndTime": String,
    "NewUsersPerMinute": Integer,
    "QueuingStatusCode": String,
    "QueuingMethod": String,
    "SiteId": Integer,
    "StartTime": String,
    "SessionDuration": Integer,
    "TotalActiveUsers": Integer,
    "WaitingRoomType": String,
    "WaitingRoomEventName": String,
    "CustomPageHtml": String,
    "Description": String,
    "DisableSessionRenewalEnable": String,
    "JsonResponseEnable": String,
    "Language": String,
    "PreQueueStartTime": String,
    "PreQueueEnable": String,
    "RandomPreQueueEnable": String,
    "WaitingRoomId": String
  }
}

Properties

Parameter	Type	Required	Updatable	Description	Constraints
EndTime	String	Yes	Yes	The timestamp when the event ends.	None
NewUsersPerMinute	Integer	Yes	Yes	The number of new users admitted per minute.	None
QueuingMethod	String	Yes	Yes	The queuing method.	Valid values: `random` `fifo`: first in, first out `passthrough` `reject-all`
QueuingStatusCode	String	Yes	Yes	The HTTP status code for the waiting room page.	Valid values: 200 202 429
SessionDuration	Integer	Yes	Yes	The duration of a user session, in minutes.	None
SiteId	Integer	Yes	No	The site ID. You can obtain this ID by calling the ListSites operation.	None
StartTime	String	Yes	Yes	The timestamp when the event starts.	None
TotalActiveUsers	Integer	Yes	Yes	The total number of active users.	None
WaitingRoomEventName	String	Yes	Yes	The name of the event.	None
WaitingRoomType	String	Yes	Yes	The type of the waiting room.	Valid values: `default`: The default type. `custom`: The custom type.
CustomPageHtml	String	No	Yes	The custom HTML content for the waiting room page.	This property is required if `WaitingRoomType` is set to `custom`. The value must be Base64-encoded.
Description	String	No	Yes	The description of the waiting room event.	None
DisableSessionRenewalEnable	String	No	Yes	Specifies whether to disable session renewal.	Valid values: `on`: disables session renewal. `off`: enables session renewal.
JsonResponseEnable	String	No	Yes	Specifies whether to return a JSON response.	Valid values: `on`: enabled `off`: disabled
Language	String	No	Yes	The default language of the waiting room page.	Valid values: `enus`: English `zhcn`: Simplified Chinese `zhhk`: Traditional Chinese
PreQueueEnable	String	No	Yes	Specifies whether to enable the pre-queue feature.	Valid values: `on`: enabled `off`: disabled
PreQueueStartTime	String	No	Yes	The start time of the pre-queue period.	None
RandomPreQueueEnable	String	No	Yes	Specifies whether to enable the random queue.	Valid values: `on`: enabled `off`: disabled
WaitingRoomId	String	No	No	The ID of the waiting room.	You can obtain this ID by calling the ListWaitingRooms operation.

Return values

Fn::GetAtt

JsonResponseEnable: Whether a JSON response is returned.
Description: The description of the waiting room event.
WaitingRoomType: The type of the waiting room.
EndTime: The timestamp when the event ends.
DisableSessionRenewalEnable: Whether session renewal is disabled.
PreQueueStartTime: The start time of the pre-queue period.
StartTime: The timestamp when the event starts.
RandomPreQueueEnable: Whether the random queue is enabled.
WaitingRoomEventId: The ID of the waiting room event. You can obtain this ID by calling the ListWaitingRoomEvents operation.
WaitingRoomEventName: The name of the event.
CustomPageHtml: The custom HTML content for the waiting room page. This value is Base64-encoded.
QueuingStatusCode: The HTTP status code for the waiting room page.
NewUsersPerMinute: The number of new users admitted per minute.
SessionDuration: The duration of a user session, in minutes.
Language: The default language of the waiting room page.
PreQueueEnable: Whether the pre-queue feature is enabled.
TotalActiveUsers: The total number of active users.
WaitingRoomId: The ID of the waiting room. You can obtain this ID by calling the ListWaitingRooms operation.
QueuingMethod: The queuing method.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  JsonResponseEnable:
    Type: String
    Description:
      en: |-
        Specifies whether to return a JSON response.
        Valid values:
        - `on`: enabled
        - `off`: disabled
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  SiteId:
    Type: Number
    Description:
      en: The site ID. You can obtain this ID by calling the ListSites operation.
    Required: true
  Description:
    Type: String
    AssociationProperty: TextArea
    Description:
      en: The description of the waiting room event.
    Required: false
  WaitingRoomType:
    Type: String
    Description:
      en: |-
        The type of the waiting room.
        Valid values:
        - `default`: The default type.
        - `custom`: The custom type.
    AllowedValues:
      - default
      - custom
    Required: true
  EndTime:
    Type: String
    Description:
      en: The timestamp when the event ends.
    Required: true
  DisableSessionRenewalEnable:
    Type: String
    Description:
      en: |-
        Specifies whether to disable session renewal.
        Valid values:
        - `on`: disables session renewal.
        - `off`: enables session renewal.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  PreQueueStartTime:
    Type: String
    Description:
      en: The start time of the pre-queue period.
    Required: false
  StartTime:
    Type: String
    Description:
      en: The timestamp when the event starts.
    Required: true
  RandomPreQueueEnable:
    Type: String
    Description:
      en: |-
        Specifies whether to enable the random queue.
        Valid values:
        - `on`: enabled
        - `off`: disabled
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  WaitingRoomEventName:
    Type: String
    Description:
      en: The name of the event.
    Required: true
  CustomPageHtml:
    Type: String
    Description:
      en: The custom HTML content for the waiting room page. This property is required if WaitingRoomType is set to custom. The value must be Base64-encoded.
    Required: false
  QueuingStatusCode:
    Type: String
    Description:
      en: |-
        The HTTP status code for the waiting room page.
        Valid values:
        - `200`
        - `202`
        - `429`
    AllowedValues:
      - '200'
      - '202'
      - '429'
    Required: true
  NewUsersPerMinute:
    Type: Number
    Description:
      en: The number of new users admitted per minute.
    Required: true
  SessionDuration:
    Type: Number
    Description:
      en: The duration of a user session, in minutes.
    Required: true
  Language:
    Type: String
    Description:
      en: |-
        The default language of the waiting room page.
        Valid values:
        - `enus`: English
        - `zhcn`: Simplified Chinese
        - `zhhk`: Traditional Chinese
    AllowedValues:
      - enus
      - zhcn
      - zhhk
    Required: false
  PreQueueEnable:
    Type: String
    Description:
      en: |-
        Specifies whether to enable the pre-queue feature.
        Valid values:
        - `on`: enabled
        - `off`: disabled
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  TotalActiveUsers:
    Type: Number
    Description:
      en: The total number of active users.
    Required: true
  WaitingRoomId:
    Type: String
    Description:
      en: The ID of the waiting room. You can obtain this ID by calling the [ListWaitingRooms](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) operation.
    Required: false
  QueuingMethod:
    Type: String
    Description:
      en: |-
        The queuing method.
        Valid values:
        - `random`
        - `fifo`: first in, first out.
        - `passthrough`
        - `reject-all`
    AllowedValues:
      - random
      - fifo
      - passthrough
      - reject-all
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::WaitingRoomEvent
    Properties:
      JsonResponseEnable:
        Ref: JsonResponseEnable
      SiteId:
        Ref: SiteId
      Description:
        Ref: Description
      WaitingRoomType:
        Ref: WaitingRoomType
      EndTime:
        Ref: EndTime
      DisableSessionRenewalEnable:
        Ref: DisableSessionRenewalEnable
      PreQueueStartTime:
        Ref: PreQueueStartTime
      StartTime:
        Ref: StartTime
      RandomPreQueueEnable:
        Ref: RandomPreQueueEnable
      WaitingRoomEventName:
        Ref: WaitingRoomEventName
      CustomPageHtml:
        Ref: CustomPageHtml
      QueuingStatusCode:
        Ref: QueuingStatusCode
      NewUsersPerMinute:
        Ref: NewUsersPerMinute
      SessionDuration:
        Ref: SessionDuration
      Language:
        Ref: Language
      PreQueueEnable:
        Ref: PreQueueEnable
      TotalActiveUsers:
        Ref: TotalActiveUsers
      WaitingRoomId:
        Ref: WaitingRoomId
      QueuingMethod:
        Ref: QueuingMethod
Outputs:
  JsonResponseEnable:
    Description: Whether a JSON response is returned.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - JsonResponseEnable
  Description:
    Description: The description of the waiting room event.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  WaitingRoomType:
    Description: The type of the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomType
  EndTime:
    Description: The timestamp when the event ends.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EndTime
  DisableSessionRenewalEnable:
    Description: Whether session renewal is disabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DisableSessionRenewalEnable
  PreQueueStartTime:
    Description: The start time of the pre-queue period.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreQueueStartTime
  StartTime:
    Description: The timestamp when the event starts.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - StartTime
  RandomPreQueueEnable:
    Description: Whether the random queue is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RandomPreQueueEnable
  WaitingRoomEventId:
    Description: The ID of the waiting room event. You can obtain this ID by calling the [ListWaitingRoomEvents](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingroomevents) operation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomEventId
  WaitingRoomEventName:
    Description: The name of the event.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomEventName
  CustomPageHtml:
    Description: The custom HTML content for the waiting room page. This value is Base64-encoded.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CustomPageHtml
  QueuingStatusCode:
    Description: The HTTP status code for the waiting room page.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingStatusCode
  NewUsersPerMinute:
    Description: The number of new users admitted per minute.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NewUsersPerMinute
  SessionDuration:
    Description: The duration of a user session, in minutes.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SessionDuration
  Language:
    Description: The default language of the waiting room page.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Language
  PreQueueEnable:
    Description: Whether the pre-queue feature is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreQueueEnable
  TotalActiveUsers:
    Description: The total number of active users.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TotalActiveUsers
  WaitingRoomId:
    Description: The ID of the waiting room. You can obtain this ID by calling the [ListWaitingRooms](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) operation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomId
  QueuingMethod:
    Description: The queuing method.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingMethod

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "JsonResponseEnable": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to return a JSON response.\nValid values:\n- `on`: enabled\n- `off`: disabled"
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID. You can obtain this ID by calling the ListSites operation."
      },
      "Required": true
    },
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": {
        "en": "The description of the waiting room event."
      },
      "Required": false
    },
    "WaitingRoomType": {
      "Type": "String",
      "Description": {
        "en": "The type of the waiting room.\nValid values:\n- `default`: The default type.\n- `custom`: The custom type."
      },
      "AllowedValues": [
        "default",
        "custom"
      ],
      "Required": true
    },
    "EndTime": {
      "Type": "String",
      "Description": {
        "en": "The timestamp when the event ends."
      },
      "Required": true
    },
    "DisableSessionRenewalEnable": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to disable session renewal.\nValid values:\n- `on`: disables session renewal.\n- `off`: enables session renewal."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "PreQueueStartTime": {
      "Type": "String",
      "Description": {
        "en": "The start time of the pre-queue period."
      },
      "Required": false
    },
    "StartTime": {
      "Type": "String",
      "Description": {
        "en": "The timestamp when the event starts."
      },
      "Required": true
    },
    "RandomPreQueueEnable": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to enable the random queue.\nValid values:\n- `on`: enabled\n- `off`: disabled"
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "WaitingRoomEventName": {
      "Type": "String",
      "Description": {
        "en": "The name of the event."
      },
      "Required": true
    },
    "CustomPageHtml": {
      "Type": "String",
      "Description": {
        "en": "The custom HTML content for the waiting room page. This property is required if WaitingRoomType is set to custom. The value must be Base64-encoded."
      },
      "Required": false
    },
    "QueuingStatusCode": {
      "Type": "String",
      "Description": {
        "en": "The HTTP status code for the waiting room page.\nValid values:\n- `200`\n- `202`\n- `429`"
      },
      "AllowedValues": [
        "200",
        "202",
        "429"
      ],
      "Required": true
    },
    "NewUsersPerMinute": {
      "Type": "Number",
      "Description": {
        "en": "The number of new users admitted per minute."
      },
      "Required": true
    },
    "SessionDuration": {
      "Type": "Number",
      "Description": {
        "en": "The duration of a user session, in minutes."
      },
      "Required": true
    },
    "Language": {
      "Type": "String",
      "Description": {
        "en": "The default language of the waiting room page.\nValid values:\n- `enus`: English\n- `zhcn`: Simplified Chinese\n- `zhhk`: Traditional Chinese"
      },
      "AllowedValues": [
        "enus",
        "zhcn",
        "zhhk"
      ],
      "Required": false
    },
    "PreQueueEnable": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to enable the pre-queue feature.\nValid values:\n- `on`: enabled\n- `off`: disabled"
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "TotalActiveUsers": {
      "Type": "Number",
      "Description": {
        "en": "The total number of active users."
      },
      "Required": true
    },
    "WaitingRoomId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the waiting room. You can obtain this ID by calling the [ListWaitingRooms](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) operation."
      },
      "Required": false
    },
    "QueuingMethod": {
      "Type": "String",
      "Description": {
        "en": "The queuing method.\nValid values:\n- `random`\n- `fifo`: first in, first out.\n- `passthrough`\n- `reject-all`"
      },
      "AllowedValues": [
        "random",
        "fifo",
        "passthrough",
        "reject-all"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::WaitingRoomEvent",
      "Properties": {
        "JsonResponseEnable": {
          "Ref": "JsonResponseEnable"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "Description": {
          "Ref": "Description"
        },
        "WaitingRoomType": {
          "Ref": "WaitingRoomType"
        },
        "EndTime": {
          "Ref": "EndTime"
        },
        "DisableSessionRenewalEnable": {
          "Ref": "DisableSessionRenewalEnable"
        },
        "PreQueueStartTime": {
          "Ref": "PreQueueStartTime"
        },
        "StartTime": {
          "Ref": "StartTime"
        },
        "RandomPreQueueEnable": {
          "Ref": "RandomPreQueueEnable"
        },
        "WaitingRoomEventName": {
          "Ref": "WaitingRoomEventName"
        },
        "CustomPageHtml": {
          "Ref": "CustomPageHtml"
        },
        "QueuingStatusCode": {
          "Ref": "QueuingStatusCode"
        },
        "NewUsersPerMinute": {
          "Ref": "NewUsersPerMinute"
        },
        "SessionDuration": {
          "Ref": "SessionDuration"
        },
        "Language": {
          "Ref": "Language"
        },
        "PreQueueEnable": {
          "Ref": "PreQueueEnable"
        },
        "TotalActiveUsers": {
          "Ref": "TotalActiveUsers"
        },
        "WaitingRoomId": {
          "Ref": "WaitingRoomId"
        },
        "QueuingMethod": {
          "Ref": "QueuingMethod"
        }
      }
    }
  },
  "Outputs": {
    "JsonResponseEnable": {
      "Description": "Whether a JSON response is returned.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "JsonResponseEnable"
        ]
      }
    },
    "Description": {
      "Description": "The description of the waiting room event.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "WaitingRoomType": {
      "Description": "The type of the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomType"
        ]
      }
    },
    "EndTime": {
      "Description": "The timestamp when the event ends.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EndTime"
        ]
      }
    },
    "DisableSessionRenewalEnable": {
      "Description": "Whether session renewal is disabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DisableSessionRenewalEnable"
        ]
      }
    },
    "PreQueueStartTime": {
      "Description": "The start time of the pre-queue period.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreQueueStartTime"
        ]
      }
    },
    "StartTime": {
      "Description": "The timestamp when the event starts.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StartTime"
        ]
      }
    },
    "RandomPreQueueEnable": {
      "Description": "Whether the random queue is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RandomPreQueueEnable"
        ]
      }
    },
    "WaitingRoomEventId": {
      "Description": "The ID of the waiting room event. You can obtain this ID by calling the [ListWaitingRoomEvents](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingroomevents) operation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomEventId"
        ]
      }
    },
    "WaitingRoomEventName": {
      "Description": "The name of the event.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomEventName"
        ]
      }
    },
    "CustomPageHtml": {
      "Description": "The custom HTML content for the waiting room page. This value is Base64-encoded.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CustomPageHtml"
        ]
      }
    },
    "QueuingStatusCode": {
      "Description": "The HTTP status code for the waiting room page.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingStatusCode"
        ]
      }
    },
    "NewUsersPerMinute": {
      "Description": "The number of new users admitted per minute.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NewUsersPerMinute"
        ]
      }
    },
    "SessionDuration": {
      "Description": "The duration of a user session, in minutes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SessionDuration"
        ]
      }
    },
    "Language": {
      "Description": "The default language of the waiting room page.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Language"
        ]
      }
    },
    "PreQueueEnable": {
      "Description": "Whether the pre-queue feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreQueueEnable"
        ]
      }
    },
    "TotalActiveUsers": {
      "Description": "The total number of active users.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TotalActiveUsers"
        ]
      }
    },
    "WaitingRoomId": {
      "Description": "The ID of the waiting room. You can obtain this ID by calling the [ListWaitingRooms](https://help.aliyun.com/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) operation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomId"
        ]
      }
    },
    "QueuingMethod": {
      "Description": "The queuing method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingMethod"
        ]
      }
    }
  }
}