Skip to content

OriginRuleProps

Properties for defining a OriginRule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-originrule

Initializer

import { OriginRuleProps } from '@alicloud/ros-cdk-esa'
const originRuleProps: OriginRuleProps = { ... }

Properties

Name Type Description
siteId number | @alicloud/ros-cdk-core.IResolvable Property siteId: The site ID.
dnsRecord string | @alicloud/ros-cdk-core.IResolvable Property dnsRecord: Overwrite the DNS resolution record of the origin request.
follow302Enable string | @alicloud/ros-cdk-core.IResolvable Property follow302Enable: Return Source 302 follow switch.
follow302MaxTries number | @alicloud/ros-cdk-core.IResolvable Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].
follow302RetainArgs string | @alicloud/ros-cdk-core.IResolvable Property follow302RetainArgs: Retain the original request parameter switch.
follow302RetainHeader string | @alicloud/ros-cdk-core.IResolvable Property follow302RetainHeader: Retain the original request header switch.
follow302TargetHost string | @alicloud/ros-cdk-core.IResolvable Property follow302TargetHost: Modify the source host after 302.
originHost string | @alicloud/ros-cdk-core.IResolvable Property originHost: The HOST carried in the back-to-origin request.
originHttpPort number | @alicloud/ros-cdk-core.IResolvable Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.
originHttpsPort number | @alicloud/ros-cdk-core.IResolvable Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.
originMtls string | @alicloud/ros-cdk-core.IResolvable Property originMtls: The mtls switch.
originReadTimeout number | @alicloud/ros-cdk-core.IResolvable Property originReadTimeout: Read timeout interval of the source station (s).
originScheme string | @alicloud/ros-cdk-core.IResolvable Property originScheme: The protocol used by the back-to-origin request.
originSni string | @alicloud/ros-cdk-core.IResolvable Property originSni: SNI carried in the back-to-origin request.
originVerify string | @alicloud/ros-cdk-core.IResolvable Property originVerify: Source station certificate verification switch.
range string | @alicloud/ros-cdk-core.IResolvable Property range: Use the range sharding method to download the file from the source.
rangeChunkSize string | @alicloud/ros-cdk-core.IResolvable Property rangeChunkSize: range shard size.
rule string | @alicloud/ros-cdk-core.IResolvable Property rule: Rule content, using conditional expressions to match user requests.
ruleEnable string | @alicloud/ros-cdk-core.IResolvable Property ruleEnable: Rule switch.
ruleName string | @alicloud/ros-cdk-core.IResolvable Property ruleName: Rule name.
sequence number | @alicloud/ros-cdk-core.IResolvable Property sequence: Order of rule execution.
siteVersion number | @alicloud/ros-cdk-core.IResolvable Property siteVersion: The version number of the site configuration.

siteIdRequired

public readonly siteId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property siteId: The site ID.


dnsRecordOptional

public readonly dnsRecord: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dnsRecord: Overwrite the DNS resolution record of the origin request.


follow302EnableOptional

public readonly follow302Enable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property follow302Enable: Return Source 302 follow switch.

Value range: - on: ON. - off: closed.


follow302MaxTriesOptional

public readonly follow302MaxTries: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].


follow302RetainArgsOptional

public readonly follow302RetainArgs: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property follow302RetainArgs: Retain the original request parameter switch.

Value range: - on: ON. - off: closed.


follow302RetainHeaderOptional

public readonly follow302RetainHeader: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property follow302RetainHeader: Retain the original request header switch.

Value range: - on: ON. - off: closed.


follow302TargetHostOptional

public readonly follow302TargetHost: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property follow302TargetHost: Modify the source host after 302.


originHostOptional

public readonly originHost: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property originHost: The HOST carried in the back-to-origin request.


originHttpPortOptional

public readonly originHttpPort: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.


originHttpsPortOptional

public readonly originHttpsPort: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.


originMtlsOptional

public readonly originMtls: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property originMtls: The mtls switch.

Value range: - on: ON. - off: closed.


originReadTimeoutOptional

public readonly originReadTimeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property originReadTimeout: Read timeout interval of the source station (s).


originSchemeOptional

public readonly originScheme: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property originScheme: The protocol used by the back-to-origin request.

Value range: - http: uses the http protocol to return to the source. - https: uses the https protocol to return to the source. - follow: follows the Client Protocol back to the source.


originSniOptional

public readonly originSni: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property originSni: SNI carried in the back-to-origin request.


originVerifyOptional

public readonly originVerify: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property originVerify: Source station certificate verification switch.

Value range: - on: ON. - off: closed.


rangeOptional

public readonly range: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property range: Use the range sharding method to download the file from the source.

Value range: - on: Open. - off: off. - force: force.


rangeChunkSizeOptional

public readonly rangeChunkSize: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property rangeChunkSize: range shard size.


ruleOptional

public readonly rule: string | IResolvable;
  • Type: string | @alicloud/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\").


ruleEnableOptional

public readonly ruleEnable: string | IResolvable;
  • Type: string | @alicloud/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.


ruleNameOptional

public readonly ruleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.


sequenceOptional

public readonly sequence: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.


siteVersionOptional

public readonly siteVersion: number | IResolvable;
  • Type: number | @alicloud/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.