ALIYUN::ESA::WaitingRoomEvent

ALIYUN::ESA::WaitingRoomEvent类型用于创建等候室事件。

语法

{
  "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
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
EndTime	String	是	是	事件结束时间的时间戳。	无
NewUsersPerMinute	Integer	是	是	每分钟新用户数量。	无
QueuingMethod	String	是	是	排队方式。	取值： random: 随机。 fifo: 先进先出。 passthrough: 直通。 reject-all: 拒绝所有。
QueuingStatusCode	String	是	是	等待室状态码。	取值： 200 202 429
SessionDuration	Integer	是	是	用户会话持续时间（分钟）。	无
SiteId	Integer	是	否	站点ID。	无
StartTime	String	是	是	事件开始时间的时间戳。	无
TotalActiveUsers	Integer	是	是	活跃用户总数。	无
WaitingRoomEventName	String	是	是	事件名称。	自定义事件描述。
WaitingRoomType	String	是	是	等待室类型。	支持以下类型： default: 默认类型。 custom: 自定义类型。
CustomPageHtml	String	否	是	用户自定义等待室页面内容。	当等待室类型为自定义类型时需要填写。传入内容需要进行base64编码。
Description	String	否	是	等待室描述。	无
DisableSessionRenewalEnable	String	否	是	禁用会话续期。	取值： on: 开启。 off: 关闭。
JsonResponseEnable	String	否	是	JSON响应开关。	取值： on: 开启。 off: 关闭。
Language	String	否	是	默认语言设置。	取值包括： enus: 英语。 zhcn: 简体中文。 zhhk: 繁体中文。
PreQueueEnable	String	否	是	预排队开关。	取值： on: 开启。 off: 关闭。
PreQueueStartTime	String	否	是	预排队开始时间。	无
RandomPreQueueEnable	String	否	是	随机队列开关。	取值： on: 开启。 off: 关闭。
WaitingRoomId	String	否	否	等待室ID。	用于标识特定的等待室。

返回值

Fn::GetAtt

JsonResponseEnable：JSON响应开关。
Description：等待室描述。
WaitingRoomType：等待室类型。
EndTime：事件结束时间的时间戳。
DisableSessionRenewalEnable：禁用会话续期。
PreQueueStartTime：预排队开始时间。
StartTime：事件开始时间的时间戳。
RandomPreQueueEnable：随机队列开关。
WaitingRoomEventId：等待室事件ID，可通过调用查询等候室事件列表操作获取。
WaitingRoomEventName：事件名称，自定义事件描述。
CustomPageHtml：用户自定义等待室页面内容，当等待室类型为自定义类型时需要填写。传入内容需要进行base64编码。
QueuingStatusCode：等待室状态码。
NewUsersPerMinute：每分钟新用户数量。
SessionDuration：用户会话持续时间（分钟）。
Language：Default language setting。
PreQueueEnable：Pre-queue switch。
TotalActiveUsers：活跃用户总数。
WaitingRoomId：等待室ID，用于标识特定的等待室。可通过调用查询等候室列表接口获取。
QueuingMethod：排队方式。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  JsonResponseEnable:
    Type: String
    Description:
      en: |-
        JSON response switch. Value:
        - `on`: open.
        - `off`: closed.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  SiteId:
    Type: Number
    Description:
      en: The site ID, which can be obtained by calling the ListSites API.
    Required: true
  Description:
    Type: String
    AssociationProperty: TextArea
    Description:
      en: Waiting room description.
    Required: false
  WaitingRoomType:
    Type: String
    Description:
      en: |-
        Waiting room type. The following types are supported:
        - `default`: the default type.
        - `custom`: custom type.
    AllowedValues:
      - default
      - custom
    Required: true
  EndTime:
    Type: String
    Description:
      en: The timestamp of the end time of the event.
    Required: true
  DisableSessionRenewalEnable:
    Type: String
    Description:
      en: |-
        Disable session renewal. Value:
        - `on`: open.
        - `off`: closed.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  PreQueueStartTime:
    Type: String
    Description:
      en: Pre-queue start time.
    Required: false
  StartTime:
    Type: String
    Description:
      en: The timestamp of the event start time.
    Required: true
  RandomPreQueueEnable:
    Type: String
    Description:
      en: |-
        Random queue switch.
        - `on`: open.
        - `off`: closed.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  WaitingRoomEventName:
    Type: String
    Description:
      en: Event name, custom event description.
    Required: true
  CustomPageHtml:
    Type: String
    Description:
      en: 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.
    Required: false
  QueuingStatusCode:
    Type: String
    Description:
      en: |-
        Waiting room status code. Value:
        - `200`
        - `202`
        - `429`.
    AllowedValues:
      - '200'
      - '202'
      - '429'
    Required: true
  NewUsersPerMinute:
    Type: Number
    Description:
      en: Number of new users per minute.
    Required: true
  SessionDuration:
    Type: Number
    Description:
      en: User session duration in minutes.
    Required: true
  Language:
    Type: String
    Description:
      en: |-
        Default language setting. Values include:
        - `enus`: English.
        - `zhcn`: Simplified Chinese.
        - `zhhk`: Traditional Chinese.
    AllowedValues:
      - enus
      - zhcn
      - zhhk
    Required: false
  PreQueueEnable:
    Type: String
    Description:
      en: |-
        Pre-queue switch.
        - `on`: open.
        - `off`: closed.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  TotalActiveUsers:
    Type: Number
    Description:
      en: Total number of active users.
    Required: true
  WaitingRoomId:
    Type: String
    Description:
      en: Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the [listwaitingroom](https://www.alibabacloud.com/help/document_detail/2850279.html) interface.
    Required: false
  QueuingMethod:
    Type: String
    Description:
      en: |-
        Way of queuing. Value:
        - `random`: random.
        - `fifo`: first in, first out.
        - `passthrough`: through.
        - `reject-all`: 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: JSON response switch.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - JsonResponseEnable
  Description:
    Description: Waiting room description.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  WaitingRoomType:
    Description: Waiting room type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomType
  EndTime:
    Description: The timestamp of the end time of the event.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EndTime
  DisableSessionRenewalEnable:
    Description: Disable session renewal.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DisableSessionRenewalEnable
  PreQueueStartTime:
    Description: Pre-queue start time.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreQueueStartTime
  StartTime:
    Description: The timestamp of the event start time.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - StartTime
  RandomPreQueueEnable:
    Description: Random queue switch.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RandomPreQueueEnable
  WaitingRoomEventId:
    Description: The waiting room event ID, which can be obtained by calling the [ListWaitingRoomEvents](https://www.alibabacloud.com/help/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingroomevents) operation.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomEventId
  WaitingRoomEventName:
    Description: Event name, custom event description.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomEventName
  CustomPageHtml:
    Description: 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.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CustomPageHtml
  QueuingStatusCode:
    Description: Waiting room status code.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingStatusCode
  NewUsersPerMinute:
    Description: Number of new users per minute.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NewUsersPerMinute
  SessionDuration:
    Description: User session duration in minutes.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SessionDuration
  Language:
    Description: Default language setting.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Language
  PreQueueEnable:
    Description: Pre-queue switch.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PreQueueEnable
  TotalActiveUsers:
    Description: Total number of active users.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TotalActiveUsers
  WaitingRoomId:
    Description: Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the [listwaitingroom](https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) interface.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomId
  QueuingMethod:
    Description: Way of queuing.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingMethod

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "JsonResponseEnable": {
      "Type": "String",
      "Description": {
        "en": "JSON response switch. Value:\n- `on`: open.\n- `off`: closed."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID, which can be obtained by calling the ListSites API."
      },
      "Required": true
    },
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": {
        "en": "Waiting room description."
      },
      "Required": false
    },
    "WaitingRoomType": {
      "Type": "String",
      "Description": {
        "en": "Waiting room type. The following types are supported:\n- `default`: the default type.\n- `custom`: custom type."
      },
      "AllowedValues": [
        "default",
        "custom"
      ],
      "Required": true
    },
    "EndTime": {
      "Type": "String",
      "Description": {
        "en": "The timestamp of the end time of the event."
      },
      "Required": true
    },
    "DisableSessionRenewalEnable": {
      "Type": "String",
      "Description": {
        "en": "Disable session renewal. Value:\n- `on`: open.\n- `off`: closed."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "PreQueueStartTime": {
      "Type": "String",
      "Description": {
        "en": "Pre-queue start time."
      },
      "Required": false
    },
    "StartTime": {
      "Type": "String",
      "Description": {
        "en": "The timestamp of the event start time."
      },
      "Required": true
    },
    "RandomPreQueueEnable": {
      "Type": "String",
      "Description": {
        "en": "Random queue switch.\n- `on`: open.\n- `off`: closed."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "WaitingRoomEventName": {
      "Type": "String",
      "Description": {
        "en": "Event name, custom event description."
      },
      "Required": true
    },
    "CustomPageHtml": {
      "Type": "String",
      "Description": {
        "en": "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."
      },
      "Required": false
    },
    "QueuingStatusCode": {
      "Type": "String",
      "Description": {
        "en": "Waiting room status code. Value:\n- `200`\n- `202`\n- `429`."
      },
      "AllowedValues": [
        "200",
        "202",
        "429"
      ],
      "Required": true
    },
    "NewUsersPerMinute": {
      "Type": "Number",
      "Description": {
        "en": "Number of new users per minute."
      },
      "Required": true
    },
    "SessionDuration": {
      "Type": "Number",
      "Description": {
        "en": "User session duration in minutes."
      },
      "Required": true
    },
    "Language": {
      "Type": "String",
      "Description": {
        "en": "Default language setting. Values include:\n- `enus`: English.\n- `zhcn`: Simplified Chinese.\n- `zhhk`: Traditional Chinese."
      },
      "AllowedValues": [
        "enus",
        "zhcn",
        "zhhk"
      ],
      "Required": false
    },
    "PreQueueEnable": {
      "Type": "String",
      "Description": {
        "en": "Pre-queue switch.\n- `on`: open.\n- `off`: closed."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "TotalActiveUsers": {
      "Type": "Number",
      "Description": {
        "en": "Total number of active users."
      },
      "Required": true
    },
    "WaitingRoomId": {
      "Type": "String",
      "Description": {
        "en": "Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the [listwaitingroom](https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingrooms) interface."
      },
      "Required": false
    },
    "QueuingMethod": {
      "Type": "String",
      "Description": {
        "en": "Way of queuing. Value:\n- `random`: random.\n- `fifo`: first in, first out.\n- `passthrough`: through.\n- `reject-all`: 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": "JSON response switch.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "JsonResponseEnable"
        ]
      }
    },
    "Description": {
      "Description": "Waiting room description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "WaitingRoomType": {
      "Description": "Waiting room type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomType"
        ]
      }
    },
    "EndTime": {
      "Description": "The timestamp of the end time of the event.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EndTime"
        ]
      }
    },
    "DisableSessionRenewalEnable": {
      "Description": "Disable session renewal.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DisableSessionRenewalEnable"
        ]
      }
    },
    "PreQueueStartTime": {
      "Description": "Pre-queue start time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreQueueStartTime"
        ]
      }
    },
    "StartTime": {
      "Description": "The timestamp of the event start time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StartTime"
        ]
      }
    },
    "RandomPreQueueEnable": {
      "Description": "Random queue switch.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RandomPreQueueEnable"
        ]
      }
    },
    "WaitingRoomEventId": {
      "Description": "The waiting room event ID, which can be obtained by calling the [ListWaitingRoomEvents](https://www.alibabacloud.com/help/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listwaitingroomevents) operation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomEventId"
        ]
      }
    },
    "WaitingRoomEventName": {
      "Description": "Event name, custom event description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomEventName"
        ]
      }
    },
    "CustomPageHtml": {
      "Description": "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.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CustomPageHtml"
        ]
      }
    },
    "QueuingStatusCode": {
      "Description": "Waiting room status code.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingStatusCode"
        ]
      }
    },
    "NewUsersPerMinute": {
      "Description": "Number of new users per minute.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NewUsersPerMinute"
        ]
      }
    },
    "SessionDuration": {
      "Description": "User session duration in minutes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SessionDuration"
        ]
      }
    },
    "Language": {
      "Description": "Default language setting.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Language"
        ]
      }
    },
    "PreQueueEnable": {
      "Description": "Pre-queue switch.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PreQueueEnable"
        ]
      }
    },
    "TotalActiveUsers": {
      "Description": "Total number of active users.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TotalActiveUsers"
        ]
      }
    },
    "WaitingRoomId": {
      "Description": "Waiting room ID, used to identify a specific waiting room. It can be obtained by calling the [listwaitingroom](https://www.alibabacloud.com/help/document_detail/2850279.html) interface.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomId"
        ]
      }
    },
    "QueuingMethod": {
      "Description": "Way of queuing.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingMethod"
        ]
      }
    }
  }
}