CacheRuleProps

Properties for defining a CacheRule.

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

Initializer

import ros_cdk_esa
ros_cdk_esa.CacheRuleProps(
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  additional_cacheable_ports: typing.Union[typing.Union[int, float], IResolvable] = None,
  browser_cache_mode: typing.Union[str, IResolvable] = None,
  browser_cache_ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  bypass_cache: typing.Union[str, IResolvable] = None,
  cache_deception_armor: typing.Union[str, IResolvable] = None,
  cache_reserve_eligibility: typing.Union[str, IResolvable] = None,
  check_presence_cookie: typing.Union[str, IResolvable] = None,
  check_presence_header: typing.Union[str, IResolvable] = None,
  edge_cache_mode: typing.Union[str, IResolvable] = None,
  edge_cache_ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  edge_status_code_cache_ttl: typing.Union[str, IResolvable] = None,
  include_cookie: typing.Union[str, IResolvable] = None,
  include_header: typing.Union[str, IResolvable] = None,
  query_string: typing.Union[str, IResolvable] = None,
  query_string_mode: typing.Union[str, IResolvable] = None,
  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,
  serve_stale: typing.Union[str, IResolvable] = None,
  site_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  sort_query_string_for_cache: typing.Union[str, IResolvable] = None,
  user_device_type: typing.Union[str, IResolvable] = None,
  user_geo: typing.Union[str, IResolvable] = None,
  user_language: typing.Union[str, IResolvable] = None
)

Properties

site_id^Required

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, which can be obtained by calling the [ListSites] API.

additional_cacheable_ports^Optional

additional_cacheable_ports: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property additionalCacheablePorts: Enable caching on specified ports.

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

browser_cache_mode^Optional

browser_cache_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

browser_cache_ttl^Optional

browser_cache_ttl: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property browserCacheTtl: Browser cache expiration time in seconds.

bypass_cache^Optional

bypass_cache: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

cache_deception_armor^Optional

cache_deception_armor: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

cache_reserve_eligibility^Optional

cache_reserve_eligibility: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

check_presence_cookie^Optional

check_presence_cookie: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

check_presence_header^Optional

check_presence_header: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

edge_cache_mode^Optional

edge_cache_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

edge_cache_ttl^Optional

edge_cache_ttl: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property edgeCacheTtl: Edge cache expiration time in seconds.

edge_status_code_cache_ttl^Optional

edge_status_code_cache_ttl: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

include_cookie^Optional

include_cookie: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

include_header^Optional

include_header: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

query_string^Optional

query_string: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property queryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

query_string_mode^Optional

query_string_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

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_enable^Optional

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_name^Optional

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.

sequence^Optional

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.

serve_stale^Optional

serve_stale: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

site_version^Optional

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.

sort_query_string_for_cache^Optional

sort_query_string_for_cache: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sortQueryStringForCache: Query string sorting, disabled by default.

Possible values:

• on: Enable.
• off: Disable.

user_device_type^Optional

user_device_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Possible values:

• on: Enable.
• off: Disable.

user_geo^Optional

user_geo: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Possible values:

• on: Enable.
• off: Disable.

user_language^Optional

user_language: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Possible values:

• on: Enable.
• off: Disable.