ALIYUN::ESA::WaitingRoomRule

更新时间:
复制为 MD 格式

ALIYUN::ESA::WaitingRoomRule类型用于创建等候室绕过规则。

语法

{
  "Type": "ALIYUN::ESA::WaitingRoomRule",
  "Properties": {
    "RuleEnable": String,
    "Rule": String,
    "RuleName": String,
    "SiteId": Integer,
    "WaitingRoomId": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Rule

String

规则内容。

实现的政策或条件表达式。

RuleEnable

String

规则开关。

添加全局配置时,不需要设置此参数。取值范围:

- on:开启。

- off:关闭。

RuleName

String

规则名称,

可选,用于按等候室旁路规则名称查询。

SiteId

Integer

站点ID。

WaitingRoomId

String

等候室ID。

用于标识特定的等候室。

返回值

Fn::GetAtt

  • RuleEnable:规则开关。添加全局配置时,不需要设置此参数。

  • Rule:规则内容,实现的政策或条件表达式。

  • RuleName:规则名称,可选,用于按等候室旁路规则名称查询。

  • WaitingRoomRuleId:规则ID,可用于查询特定规则。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SiteId:
    Type: Number
    Description:
      en: The site ID, which can be obtained by calling the ListSites API.
    Required: true
  RuleEnable:
    Type: String
    Description:
      en: |-
        Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
        - on: open.
        - off: close.
    AllowedValues:
      - 'on'
      - 'off'
    Required: true
  Rule:
    Type: String
    Description:
      en: The content of the rule, the implemented policy or conditional expression.
    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://help.aliyun.com/document_detail/2850279.html) interface.
    Required: true
  RuleName:
    Type: String
    Description:
      en: Rule name, optional, used to query by waiting room bypass rule name.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::WaitingRoomRule
    Properties:
      SiteId:
        Ref: SiteId
      RuleEnable:
        Ref: RuleEnable
      Rule:
        Ref: Rule
      WaitingRoomId:
        Ref: WaitingRoomId
      RuleName:
        Ref: RuleName
Outputs:
  RuleEnable:
    Description: Rule switch. When adding global configuration, this parameter does not need to be set.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleEnable
  Rule:
    Description: The content of the rule, the implemented policy or conditional expression.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Rule
  RuleName:
    Description: Rule name, optional, used to query by waiting room bypass rule name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleName
  WaitingRoomRuleId:
    Description: The rule ID, which can be used to query a specific rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomRuleId
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID, which can be obtained by calling the ListSites API."
      },
      "Required": true
    },
    "RuleEnable": {
      "Type": "String",
      "Description": {
        "en": "Rule switch. When adding global configuration, this parameter does not need to be set. Value range:\n- on: open.\n- off: close."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": true
    },
    "Rule": {
      "Type": "String",
      "Description": {
        "en": "The content of the rule, the implemented policy or conditional expression."
      },
      "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://help.aliyun.com/document_detail/2850279.html) interface."
      },
      "Required": true
    },
    "RuleName": {
      "Type": "String",
      "Description": {
        "en": "Rule name, optional, used to query by waiting room bypass rule name."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::WaitingRoomRule",
      "Properties": {
        "SiteId": {
          "Ref": "SiteId"
        },
        "RuleEnable": {
          "Ref": "RuleEnable"
        },
        "Rule": {
          "Ref": "Rule"
        },
        "WaitingRoomId": {
          "Ref": "WaitingRoomId"
        },
        "RuleName": {
          "Ref": "RuleName"
        }
      }
    }
  },
  "Outputs": {
    "RuleEnable": {
      "Description": "Rule switch. When adding global configuration, this parameter does not need to be set.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleEnable"
        ]
      }
    },
    "Rule": {
      "Description": "The content of the rule, the implemented policy or conditional expression.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Rule"
        ]
      }
    },
    "RuleName": {
      "Description": "Rule name, optional, used to query by waiting room bypass rule name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleName"
        ]
      }
    },
    "WaitingRoomRuleId": {
      "Description": "The rule ID, which can be used to query a specific rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomRuleId"
        ]
      }
    }
  }
}