CustomResponseCodeRuleProps
Properties for defining a CustomResponseCodeRule.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-customresponsecoderule
Initializer
import ros_cdk_esa
ros_cdk_esa.CustomResponseCodeRuleProps(
page_id: typing.Union[str, IResolvable],
return_code: typing.Union[str, IResolvable],
site_id: typing.Union[typing.Union[int, float], IResolvable],
rule: typing.Union[str, IResolvable] = None,
rule_enable: typing.Union[str, IResolvable] = None,
rule_name: typing.Union[str, IResolvable] = None,
sequence: typing.Union[typing.Union[int, float], IResolvable] = None,
site_version: typing.Union[typing.Union[int, float], IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
page_id | typing.Union[str, ros_cdk_core.IResolvable] | Property pageId: The custom response page. |
return_code | typing.Union[str, ros_cdk_core.IResolvable] | Property returnCode: The custom response code. |
site_id | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property siteId: The site ID. |
rule | typing.Union[str, ros_cdk_core.IResolvable] | Property rule: Rule content, using conditional expressions to match user requests. |
rule_enable | typing.Union[str, ros_cdk_core.IResolvable] | Property ruleEnable: Rule switch. |
rule_name | typing.Union[str, ros_cdk_core.IResolvable] | Property ruleName: Rule name. |
sequence | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property sequence: Order of rule execution. |
site_version | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property siteVersion: The version number of the site configuration. |
page_idRequired
page_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property pageId: The custom response page.
return_codeRequired
return_code: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property returnCode: The custom response code.
site_idRequired
site_id: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property siteId: The site ID.
ruleOptional
rule: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property rule: Rule content, using conditional expressions to match user requests.
When adding global configuration, this parameter does not need to be set. There are two usage scenarios:
- Match all incoming requests: value set to true
- Match specified request: Set the value to a custom expression, for example: (http.host eq "video.example.com").
rule_enableOptional
rule_enable: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ruleEnable: Rule switch.
When adding global configuration, this parameter does not need to be set. Value range:
- on: open.
- off: close.
rule_nameOptional
rule_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ruleName: Rule name.
When adding global configuration, this parameter does not need to be set.
sequenceOptional
sequence: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property sequence: Order of rule execution.
The smaller the value, the higher the priority for execution.
site_versionOptional
site_version: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property siteVersion: The version number of the site configuration.
For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.