CacheRule

• Implements: ICacheRule

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

Initializers

import { CacheRule } from '@alicloud/ros-cdk-esa'
new CacheRule(scope: Construct, id: string, props: CacheRuleProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: CacheRuleProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { CacheRule } from '@alicloud/ros-cdk-esa'
CacheRule.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAdditionalCacheablePorts^Required

public readonly attrAdditionalCacheablePorts: string | IResolvable;

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

Attribute AdditionalCacheablePorts: Enable caching on specified ports.

attrBrowserCacheMode^Required

public readonly attrBrowserCacheMode: string | IResolvable;

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

Attribute BrowserCacheMode: Browser cache mode.

attrBrowserCacheTtl^Required

public readonly attrBrowserCacheTtl: string | IResolvable;

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

Attribute BrowserCacheTtl: Browser cache expiration time in seconds.

attrBypassCache^Required

public readonly attrBypassCache: string | IResolvable;

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

Attribute BypassCache: Set the bypass cache mode.

attrCacheDeceptionArmor^Required

public readonly attrCacheDeceptionArmor: string | IResolvable;

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

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

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

Attribute CacheRuleId: Cache Rule Id.

attrCheckPresenceCookie^Required

public readonly attrCheckPresenceCookie: string | IResolvable;

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

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

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

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

attrEdgeCacheMode^Required

public readonly attrEdgeCacheMode: string | IResolvable;

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

Attribute EdgeCacheMode: Edge cache mode.

attrEdgeCacheTtl^Required

public readonly attrEdgeCacheTtl: string | IResolvable;

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

Attribute EdgeCacheTtl: Edge cache expiration time in seconds.

attrEdgeStatusCodeCacheTtl^Required

public readonly attrEdgeStatusCodeCacheTtl: string | IResolvable;

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

Attribute EdgeStatusCodeCacheTtl: Status code cache expiration time in seconds.

attrIncludeCookie^Required

public readonly attrIncludeCookie: string | IResolvable;

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

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

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

Attribute QueryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

attrQueryStringMode^Required

public readonly attrQueryStringMode: string | IResolvable;

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

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

attrRule^Required

public readonly attrRule: string | IResolvable;

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

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

Attribute RuleEnable: Rule switch.

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

attrRuleName^Required

public readonly attrRuleName: string | IResolvable;

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

Attribute RuleName: Rule name.

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

attrSequence^Required

public readonly attrSequence: string | IResolvable;

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

Attribute Sequence: Order of rule execution.

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

attrServeStale^Required

public readonly attrServeStale: string | IResolvable;

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

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

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

Attribute SortQueryStringForCache: Query string sorting, disabled by default.

attrUserDeviceType^Required

public readonly attrUserDeviceType: string | IResolvable;

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

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

attrUserGeo^Required

public readonly attrUserGeo: string | IResolvable;

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

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

attrUserLanguage^Required

public readonly attrUserLanguage: string | IResolvable;

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

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

props^Required

public readonly props: CacheRuleProps;

• Type: CacheRuleProps