ALIYUN::ESA::RoutineRoute - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::ESA::RoutineRoute",
  "Properties": {
    "RoutineName": String,
    "SiteId": Integer,
    "Bypass": String,
    "Fallback": String,
    "RouteName": String,
    "RouteEnable": String,
    "Rule": String,
    "Sequence": Integer
  }
}

Properties

Parameter	Type	Required	Update Allowed	Description	Constraints
RoutineName	String	Yes	No	The name of the edge function routine.	None
SiteId	Integer	Yes	No	The site ID.	None
Bypass	String	No	Yes	Specifies whether to enable bypass mode.	Valid values: `on`: Enabled `off`: Disabled
Fallback	String	No	Yes	Specifies whether to enable exception origin fetch. If enabled, requests are routed back to the origin when a function exception occurs, for example, when the CPU usage exceeds its limit.	Valid values: `on`: Enabled `off`: Disabled
RouteEnable	String	No	Yes	Specifies whether to enable the route.	Valid values: `on`: Enabled `off`: Disabled
RouteName	String	No	Yes	The name of the route.	None
Rule	String	No	Yes	The content of the rule.	None
Sequence	Integer	No	Yes	The rule execution order.	None

Return values

Fn::GetAtt

RoutineName: The name of the edge function routine.
Bypass: Indicates whether bypass mode is enabled.
Mode: The configuration mode.
Fallback: Indicates whether exception origin fetch is enabled. If enabled, requests are routed back to the origin when a function exception occurs.
RouteName: The name of the route.
Sequence: The rule execution order.
RouteEnable: Indicates whether the route is enabled.
Rule: The content of the rule.
ConfigId: The configuration ID.
SiteVersion: The site version number.
ConfigType: The configuration type. This value distinguishes between global and rule configurations.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RoutineName:
    Type: String
    Description:
      en: The name of the edge function routine.
    Required: true
  SiteId:
    Type: Number
    Description:
      en: The site ID.
    Required: true
  Bypass:
    Type: String
    Description:
      en: Specifies the bypass mode.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  Fallback:
    Type: String
    Description:
      en: Specifies whether to enable exception origin fetch. If enabled, requests are routed back to the origin when a function exception occurs, for example, when the CPU usage exceeds its limit.
    Required: false
  RouteName:
    Type: String
    Description:
      en: The name of the route.
    Required: false
  Sequence:
    Type: Number
    Description:
      en: The rule execution order.
    Required: false
  RouteEnable:
    Type: String
    Description:
      en: Specifies whether to enable the route.
    AllowedValues:
      - 'on'
      - 'off'
    Required: false
  Rule:
    Type: String
    Description:
      en: The content of the rule.
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::RoutineRoute
    Properties:
      RoutineName:
        Ref: RoutineName
      SiteId:
        Ref: SiteId
      Bypass:
        Ref: Bypass
      Fallback:
        Ref: Fallback
      RouteName:
        Ref: RouteName
      Sequence:
        Ref: Sequence
      RouteEnable:
        Ref: RouteEnable
      Rule:
        Ref: Rule
Outputs:
  RoutineName:
    Description: The name of the edge function routine.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RoutineName
  Bypass:
    Description: Indicates whether bypass mode is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Bypass
  Mode:
    Description: The configuration mode.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Mode
  Fallback:
    Description: Indicates whether exception origin fetch is enabled. If enabled, requests are routed back to the origin when a function exception occurs, for example, when the CPU usage exceeds its limit.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Fallback
  RouteName:
    Description: The name of the route.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RouteName
  Sequence:
    Description: The rule execution order.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Sequence
  RouteEnable:
    Description: Indicates whether the route is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - RouteEnable
  Rule:
    Description: The content of the rule.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Rule
  ConfigId:
    Description: The configuration ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigId
  SiteVersion:
    Description: The site version number.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SiteVersion
  ConfigType:
    Description: The configuration type. This value distinguishes between global and rule configurations.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConfigType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RoutineName": {
      "Type": "String",
      "Description": {
        "en": "The name of the edge function routine."
      },
      "Required": true
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID."
      },
      "Required": true
    },
    "Bypass": {
      "Type": "String",
      "Description": {
        "en": "Specifies the bypass mode."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "Fallback": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to enable exception origin fetch. If enabled, requests are routed back to the origin when a function exception occurs, for example, when the CPU usage exceeds its limit."
      },
      "Required": false
    },
    "RouteName": {
      "Type": "String",
      "Description": {
        "en": "The name of the route."
      },
      "Required": false
    },
    "Sequence": {
      "Type": "Number",
      "Description": {
        "en": "The rule execution order."
      },
      "Required": false
    },
    "RouteEnable": {
      "Type": "String",
      "Description": {
        "en": "Specifies whether to enable the route."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": false
    },
    "Rule": {
      "Type": "String",
      "Description": {
        "en": "The content of the rule."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::RoutineRoute",
      "Properties": {
        "RoutineName": {
          "Ref": "RoutineName"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "Bypass": {
          "Ref": "Bypass"
        },
        "Fallback": {
          "Ref": "Fallback"
        },
        "RouteName": {
          "Ref": "RouteName"
        },
        "Sequence": {
          "Ref": "Sequence"
        },
        "RouteEnable": {
          "Ref": "RouteEnable"
        },
        "Rule": {
          "Ref": "Rule"
        }
      }
    }
  },
  "Outputs": {
    "RoutineName": {
      "Description": "The name of the edge function routine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RoutineName"
        ]
      }
    },
    "Bypass": {
      "Description": "Indicates whether bypass mode is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Bypass"
        ]
      }
    },
    "Mode": {
      "Description": "The configuration mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Mode"
        ]
      }
    },
    "Fallback": {
      "Description": "Indicates whether exception origin fetch is enabled. If enabled, requests are routed back to the origin when a function exception occurs, for example, when the CPU usage exceeds its limit.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Fallback"
        ]
      }
    },
    "RouteName": {
      "Description": "The name of the route.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RouteName"
        ]
      }
    },
    "Sequence": {
      "Description": "The rule execution order.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Sequence"
        ]
      }
    },
    "RouteEnable": {
      "Description": "Indicates whether the route is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RouteEnable"
        ]
      }
    },
    "Rule": {
      "Description": "The content of the rule.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Rule"
        ]
      }
    },
    "ConfigId": {
      "Description": "The configuration ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigId"
        ]
      }
    },
    "SiteVersion": {
      "Description": "The site version number.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SiteVersion"
        ]
      }
    },
    "ConfigType": {
      "Description": "The configuration type. This value distinguishes between global and rule configurations.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConfigType"
        ]
      }
    }
  }
}