CacheRule

• Implements: ICacheRule

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

Initializers

import com.aliyun.ros.cdk.esa.CacheRule;
CacheRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .additionalCacheablePorts(java.lang.Number)
//  .additionalCacheablePorts(IResolvable)
//  .browserCacheMode(java.lang.String)
//  .browserCacheMode(IResolvable)
//  .browserCacheTtl(java.lang.Number)
//  .browserCacheTtl(IResolvable)
//  .bypassCache(java.lang.String)
//  .bypassCache(IResolvable)
//  .cacheDeceptionArmor(java.lang.String)
//  .cacheDeceptionArmor(IResolvable)
//  .cacheReserveEligibility(java.lang.String)
//  .cacheReserveEligibility(IResolvable)
//  .checkPresenceCookie(java.lang.String)
//  .checkPresenceCookie(IResolvable)
//  .checkPresenceHeader(java.lang.String)
//  .checkPresenceHeader(IResolvable)
//  .edgeCacheMode(java.lang.String)
//  .edgeCacheMode(IResolvable)
//  .edgeCacheTtl(java.lang.Number)
//  .edgeCacheTtl(IResolvable)
//  .edgeStatusCodeCacheTtl(java.lang.String)
//  .edgeStatusCodeCacheTtl(IResolvable)
//  .includeCookie(java.lang.String)
//  .includeCookie(IResolvable)
//  .includeHeader(java.lang.String)
//  .includeHeader(IResolvable)
//  .queryString(java.lang.String)
//  .queryString(IResolvable)
//  .queryStringMode(java.lang.String)
//  .queryStringMode(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .sequence(java.lang.Number)
//  .sequence(IResolvable)
//  .serveStale(java.lang.String)
//  .serveStale(IResolvable)
//  .siteVersion(java.lang.Number)
//  .siteVersion(IResolvable)
//  .sortQueryStringForCache(java.lang.String)
//  .sortQueryStringForCache(IResolvable)
//  .userDeviceType(java.lang.String)
//  .userDeviceType(IResolvable)
//  .userGeo(java.lang.String)
//  .userGeo(IResolvable)
//  .userLanguage(java.lang.String)
//  .userLanguage(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

siteId^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

additionalCacheablePorts^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property additionalCacheablePorts: Enable caching on specified ports.

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

browserCacheMode^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property browserCacheTtl: Browser cache expiration time in seconds.

bypassCache^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property edgeCacheTtl: Edge cache expiration time in seconds.

edgeStatusCodeCacheTtl^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

queryStringMode^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleName: Rule name.

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

sequence^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property sequence: Order of rule execution.

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

serveStale^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sortQueryStringForCache: Query string sorting, disabled by default.

Possible values:

• on: Enable.
• off: Disable.

userDeviceType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Possible values:

• on: Enable.
• off: Disable.

userGeo^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Possible values:

• on: Enable.
• off: Disable.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.CacheRule;
CacheRule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAdditionalCacheablePorts^Required

public java.lang.Object getAttrAdditionalCacheablePorts();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AdditionalCacheablePorts: Enable caching on specified ports.

attrBrowserCacheMode^Required

public java.lang.Object getAttrBrowserCacheMode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BrowserCacheMode: Browser cache mode.

attrBrowserCacheTtl^Required

public java.lang.Object getAttrBrowserCacheTtl();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BrowserCacheTtl: Browser cache expiration time in seconds.

attrBypassCache^Required

public java.lang.Object getAttrBypassCache();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BypassCache: Set the bypass cache mode.

attrCacheDeceptionArmor^Required

public java.lang.Object getAttrCacheDeceptionArmor();

• Type: java.lang.String OR com.aliyun.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.

attrCacheReserveEligibility^Required

public java.lang.Object getAttrCacheReserveEligibility();

• Type: java.lang.String OR com.aliyun.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.

attrCacheRuleId^Required

public java.lang.Object getAttrCacheRuleId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CacheRuleId: Cache Rule Id.

attrCheckPresenceCookie^Required

public java.lang.Object getAttrCheckPresenceCookie();

• Type: java.lang.String OR com.aliyun.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.

attrCheckPresenceHeader^Required

public java.lang.Object getAttrCheckPresenceHeader();

• Type: java.lang.String OR com.aliyun.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.

attrConfigType^Required

public java.lang.Object getAttrConfigType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrEdgeCacheMode^Required

public java.lang.Object getAttrEdgeCacheMode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EdgeCacheMode: Edge cache mode.

attrEdgeCacheTtl^Required

public java.lang.Object getAttrEdgeCacheTtl();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EdgeCacheTtl: Edge cache expiration time in seconds.

attrEdgeStatusCodeCacheTtl^Required

public java.lang.Object getAttrEdgeStatusCodeCacheTtl();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EdgeStatusCodeCacheTtl: Status code cache expiration time in seconds.

attrIncludeCookie^Required

public java.lang.Object getAttrIncludeCookie();

• Type: java.lang.String OR com.aliyun.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.

attrIncludeHeader^Required

public java.lang.Object getAttrIncludeHeader();

• Type: java.lang.String OR com.aliyun.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.

attrQueryString^Required

public java.lang.Object getAttrQueryString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute QueryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

attrQueryStringMode^Required

public java.lang.Object getAttrQueryStringMode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrRule^Required

public java.lang.Object getAttrRule();

• Type: java.lang.String OR com.aliyun.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.

attrRuleEnable^Required

public java.lang.Object getAttrRuleEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RuleEnable: Rule switch.

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

attrRuleName^Required

public java.lang.Object getAttrRuleName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RuleName: Rule name.

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

attrSequence^Required

public java.lang.Object getAttrSequence();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Sequence: Order of rule execution.

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

attrServeStale^Required

public java.lang.Object getAttrServeStale();

• Type: java.lang.String OR com.aliyun.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.

attrSiteVersion^Required

public java.lang.Object getAttrSiteVersion();

• Type: java.lang.String OR com.aliyun.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.

attrSortQueryStringForCache^Required

public java.lang.Object getAttrSortQueryStringForCache();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SortQueryStringForCache: Query string sorting, disabled by default.

attrUserDeviceType^Required

public java.lang.Object getAttrUserDeviceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUserGeo^Required

public java.lang.Object getAttrUserGeo();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUserLanguage^Required

public java.lang.Object getAttrUserLanguage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public CacheRuleProps getProps();

• Type: CacheRuleProps