ALIYUN::ESA::WaitingRoomRule - Resource Orchestration Service

Syntax

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

Properties

Parameter	Type	Required	Updatable	Description	Constraint
Rule	String	Yes	Yes	The rule content.	The policy or conditional expression defined in the rule.
RuleEnable	String	Yes	Yes	The state of the rule.	You do not need to set this parameter when you add a global configuration. Valid values: - `on`: The rule is enabled. - `off`: The rule is disabled.
RuleName	String	Yes	Yes	The rule name.	Optional. You can use this name to query the waiting room bypass rule.
SiteId	Integer	Yes	No	The site ID.	None
WaitingRoomId	String	Yes	No	The waiting room ID.	Identifies a specific waiting room.

Return values

Fn::GetAtt

RuleEnable: The state of the rule (on or off).
Rule: The policy or conditional expression defined in the rule.
RuleName: The name of the rule.
WaitingRoomRuleId: The unique ID of the rule.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SiteId:
    Type: Number
    Description:
      en: The site ID. You can obtain this ID by calling the ListSites API.
    Required: true
  RuleEnable:
    Type: String
    Description:
      en: |-
        The state of the rule. This parameter is not required when you add a global configuration. Valid values:
        - `on`: Enables the rule.
        - `off`: Disables the rule.
    AllowedValues:
      - 'on'
      - 'off'
    Required: true
  Rule:
    Type: String
    Description:
      en: The policy or conditional expression defined in the rule.
    Required: true
  WaitingRoomId:
    Type: String
    Description:
      en: The ID of the waiting room. You can obtain this ID by calling the `listwaitingroom` API.
    Required: true
  RuleName:
    Type: String
    Description:
      en: The name of the rule. Optional. You can use this name to query the waiting room bypass rule.
    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: The state of the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleEnable
  Rule:
    Description: The policy or conditional expression defined in the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Rule
  RuleName:
    Description: The name of the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RuleName
  WaitingRoomRuleId:
    Description: The unique ID of the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomRuleId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID. You can obtain this ID by calling the ListSites API."
      },
      "Required": true
    },
    "RuleEnable": {
      "Type": "String",
      "Description": {
        "en": "The state of the rule. This parameter is not required when you add a global configuration. Valid values:\n- `on`: Enables the rule.\n- `off`: Disables the rule."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": true
    },
    "Rule": {
      "Type": "String",
      "Description": {
        "en": "The policy or conditional expression defined in the rule."
      },
      "Required": true
    },
    "WaitingRoomId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the waiting room. You can obtain this ID by calling the `listwaitingroom` API."
      },
      "Required": true
    },
    "RuleName": {
      "Type": "String",
      "Description": {
        "en": "The name of the rule. Optional. You can use this name to query the waiting room bypass rule."
      },
      "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": "The state of the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleEnable"
        ]
      }
    },
    "Rule": {
      "Description": "The policy or conditional expression defined in the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Rule"
        ]
      }
    },
    "RuleName": {
      "Description": "The name of the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RuleName"
        ]
      }
    },
    "WaitingRoomRuleId": {
      "Description": "The unique ID of the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomRuleId"
        ]
      }
    }
  }
}