CacheRule

• Implements: ICacheRule

This class encapsulates and extends the ROS resource type ALIYUN::ESA::CacheRule.

Initializers

import ros_cdk_esa
ros_cdk_esa.CacheRule(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

site_id^Required

• 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

• 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

• 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

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

Property browserCacheTtl: Browser cache expiration time in seconds.

bypass_cache^Optional

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_esa
ros_cdk_esa.CacheRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_additional_cacheable_ports^Required

attr_additional_cacheable_ports: typing.Union[str, IResolvable]

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

Attribute AdditionalCacheablePorts: Enable caching on specified ports.

attr_browser_cache_mode^Required

attr_browser_cache_mode: typing.Union[str, IResolvable]

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

Attribute BrowserCacheMode: Browser cache mode.

attr_browser_cache_ttl^Required

attr_browser_cache_ttl: typing.Union[str, IResolvable]

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

Attribute BrowserCacheTtl: Browser cache expiration time in seconds.

attr_bypass_cache^Required

attr_bypass_cache: typing.Union[str, IResolvable]

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

Attribute BypassCache: Set the bypass cache mode.

attr_cache_deception_armor^Required

attr_cache_deception_armor: typing.Union[str, IResolvable]

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

Attribute CacheDeceptionArmor: Cache deception protection.

Used to defend against web cache deception attacks, only the cache content that passes the validation will be cached.

attr_cache_reserve_eligibility^Required

attr_cache_reserve_eligibility: typing.Union[str, IResolvable]

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

Attribute CacheReserveEligibility: Cache retention eligibility.

Used to control whether user requests bypass the cache retention node when returning to the origin.

attr_cache_rule_id^Required

attr_cache_rule_id: typing.Union[str, IResolvable]

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

Attribute CacheRuleId: Cache Rule Id.

attr_check_presence_cookie^Required

attr_check_presence_cookie: typing.Union[str, IResolvable]

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

Attribute 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.

attr_check_presence_header^Required

attr_check_presence_header: typing.Union[str, IResolvable]

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

Attribute 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.

attr_config_type^Required

attr_config_type: typing.Union[str, IResolvable]

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

Attribute ConfigType: Configuration type, which can be used to query global or rule-based configurations.

attr_edge_cache_mode^Required

attr_edge_cache_mode: typing.Union[str, IResolvable]

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

Attribute EdgeCacheMode: Edge cache mode.

attr_edge_cache_ttl^Required

attr_edge_cache_ttl: typing.Union[str, IResolvable]

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

Attribute EdgeCacheTtl: Edge cache expiration time in seconds.

attr_edge_status_code_cache_ttl^Required

attr_edge_status_code_cache_ttl: typing.Union[str, IResolvable]

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

Attribute EdgeStatusCodeCacheTtl: Status code cache expiration time in seconds.

attr_include_cookie^Required

attr_include_cookie: typing.Union[str, IResolvable]

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

Attribute IncludeCookie: When generating the cache key, add the specified cookie names and their values.

Multiple values are supported, separated by spaces.

attr_include_header^Required

attr_include_header: typing.Union[str, IResolvable]

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

Attribute IncludeHeader: When generating the cache key, add the specified header names and their values.

Multiple values are supported, separated by spaces.

attr_query_string^Required

attr_query_string: typing.Union[str, IResolvable]

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

Attribute QueryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

attr_query_string_mode^Required

attr_query_string_mode: typing.Union[str, IResolvable]

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

Attribute QueryStringMode: The processing mode for query strings when generating the cache key.

attr_rule^Required

attr_rule: typing.Union[str, IResolvable]

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

Attribute Rule: Rule content, using conditional expressions to match user requests.

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

attr_rule_enable^Required

attr_rule_enable: typing.Union[str, IResolvable]

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

Attribute RuleEnable: Rule switch.

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

attr_rule_name^Required

attr_rule_name: typing.Union[str, IResolvable]

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

Attribute RuleName: Rule name.

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

attr_sequence^Required

attr_sequence: typing.Union[str, IResolvable]

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

Attribute Sequence: Order of rule execution.

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

attr_serve_stale^Required

attr_serve_stale: typing.Union[str, IResolvable]

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

Attribute ServeStale: Serve stale cache.

When enabled, the node can still respond to user requests with expired cached files when the origin server is unavailable.

attr_site_version^Required

attr_site_version: typing.Union[str, IResolvable]

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

Attribute 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.

attr_sort_query_string_for_cache^Required

attr_sort_query_string_for_cache: typing.Union[str, IResolvable]

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

Attribute SortQueryStringForCache: Query string sorting, disabled by default.

attr_user_device_type^Required

attr_user_device_type: typing.Union[str, IResolvable]

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

Attribute UserDeviceType: When generating the cache key, add the client device type.

attr_user_geo^Required

attr_user_geo: typing.Union[str, IResolvable]

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

Attribute UserGeo: When generating the cache key, add the client's geographic location.

attr_user_language^Required

attr_user_language: typing.Union[str, IResolvable]

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

Attribute UserLanguage: When generating cache keys, include the client's language type.

props^Required

props: CacheRuleProps

• Type: CacheRuleProps