CacheRuleProps

Properties for defining a CacheRule.

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

Initializer

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

Properties

siteId^Required

public readonly siteId: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property siteId: The site ID, which can be obtained by calling the [ListSites] API.

additionalCacheablePorts^Optional

public readonly additionalCacheablePorts: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property additionalCacheablePorts: Enable caching on specified ports.

Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.

browserCacheMode^Optional

public readonly browserCacheMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property browserCacheMode: Browser cache mode.

Possible values: - no_cacheno_cache: Do not cache. - follow_origin: Follow the origin server's cache policy. - override_origin: Override the origin server's cache policy.

browserCacheTtl^Optional

public readonly browserCacheTtl: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property browserCacheTtl: Browser cache expiration time in seconds.

bypassCache^Optional

public readonly bypassCache: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property bypassCache: Set the bypass cache mode.

Possible values: - cache_all: Cache all requests. - bypass_all: Bypass cache for all requests.

cacheDeceptionArmor^Optional

public readonly cacheDeceptionArmor: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property cacheDeceptionArmor: Cache deception protection.

Used to defend against web cache deception attacks, only the cache content that passes the validation will be cached. Value range: - on: Enabled. - off: Disabled.

cacheReserveEligibility^Optional

public readonly cacheReserveEligibility: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property cacheReserveEligibility: Cache retention eligibility.

Used to control whether user requests bypass the cache retention node when returning to the origin. Possible values: - bypass_cache_reserve: Requests bypass cache retention. - eligible_for_cache_reserve: Eligible for cache retention.

checkPresenceCookie^Optional

public readonly checkPresenceCookie: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property checkPresenceCookie: When generating the cache key, check if the cookie exists.

If it does, add the cookie name (case-insensitive) to the cache key. Multiple cookie names are supported, separated by spaces.

checkPresenceHeader^Optional

public readonly checkPresenceHeader: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property checkPresenceHeader: When generating the cache key, check if the header exists.

If it does, add the header name (case-insensitive) to the cache key. Multiple header names are supported, separated by spaces.

edgeCacheMode^Optional

public readonly edgeCacheMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property edgeCacheMode: Edge cache mode.

Possible values: - follow_origin: Follow the origin server's cache policy (if it exists), otherwise use the default cache policy. - no_cache: Do not cache. - override_origin: Override the origin server's cache policy. - follow_origin_bypass: Follow the origin server's cache policy (if it exists), otherwise do not cache.

edgeCacheTtl^Optional

public readonly edgeCacheTtl: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property edgeCacheTtl: Edge cache expiration time in seconds.

edgeStatusCodeCacheTtl^Optional

public readonly edgeStatusCodeCacheTtl: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property edgeStatusCodeCacheTtl: Status code cache expiration time in seconds.

Multiple values are separated by commas, for example: 4xx=999999,5xx=999998

includeCookie^Optional

public readonly includeCookie: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property includeCookie: When generating the cache key, add the specified cookie names and their values.

Multiple values are supported, separated by spaces.

includeHeader^Optional

public readonly includeHeader: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property includeHeader: When generating the cache key, add the specified header names and their values.

Multiple values are supported, separated by spaces.

queryString^Optional

public readonly queryString: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property queryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

queryStringMode^Optional

public readonly queryStringMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property queryStringMode: The processing mode for query strings when generating the cache key.

Possible values: - ignore_all: Ignore all. - exclude_query_string: Exclude specified query strings. - reserve_all: Default, reserve all. - include_query_string: Include specified query strings.

rule^Optional

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\").

ruleEnable^Optional

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.

ruleName^Optional

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.

sequence^Optional

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.

serveStale^Optional

public readonly serveStale: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property serveStale: Serve stale cache.

When enabled, the node can still respond to user requests with expired cached files when the origin server is unavailable. Value range: - on: Enabled. - off: Disabled.

siteVersion^Optional

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.

sortQueryStringForCache^Optional

public readonly sortQueryStringForCache: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property sortQueryStringForCache: Query string sorting, disabled by default.

Possible values: - on: Enable. - off: Disable.

userDeviceType^Optional

public readonly userDeviceType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property userDeviceType: When generating the cache key, add the client device type.

Possible values: - on: Enable. - off: Disable.

userGeo^Optional

public readonly userGeo: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property userGeo: When generating the cache key, add the client's geographic location.

Possible values: - on: Enable. - off: Disable.

userLanguage^Optional

public readonly userLanguage: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property userLanguage: When generating cache keys, include the client's language type.

Possible values: - on: Enable. - off: Disable.