CacheRule

• Implements: ICacheRule

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Esa;
new CacheRule(Construct Scope, string Id, CacheRuleProps Props, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Required

• Type: CacheRuleProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Esa;
CacheRule.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAdditionalCacheablePorts^Required

public object AttrAdditionalCacheablePorts { get; }

• Type: object

Attribute AdditionalCacheablePorts: Enable caching on specified ports.

AttrBrowserCacheMode^Required

public object AttrBrowserCacheMode { get; }

• Type: object

Attribute BrowserCacheMode: Browser cache mode.

AttrBrowserCacheTtl^Required

public object AttrBrowserCacheTtl { get; }

• Type: object

Attribute BrowserCacheTtl: Browser cache expiration time in seconds.

AttrBypassCache^Required

public object AttrBypassCache { get; }

• Type: object

Attribute BypassCache: Set the bypass cache mode.

AttrCacheDeceptionArmor^Required

public object AttrCacheDeceptionArmor { get; }

• Type: object

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 object AttrCacheReserveEligibility { get; }

• Type: object

Attribute CacheReserveEligibility: Cache retention eligibility.

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

AttrCacheRuleId^Required

public object AttrCacheRuleId { get; }

• Type: object

Attribute CacheRuleId: Cache Rule Id.

AttrCheckPresenceCookie^Required

public object AttrCheckPresenceCookie { get; }

• Type: object

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 object AttrCheckPresenceHeader { get; }

• Type: object

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 object AttrConfigType { get; }

• Type: object

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

AttrEdgeCacheMode^Required

public object AttrEdgeCacheMode { get; }

• Type: object

Attribute EdgeCacheMode: Edge cache mode.

AttrEdgeCacheTtl^Required

public object AttrEdgeCacheTtl { get; }

• Type: object

Attribute EdgeCacheTtl: Edge cache expiration time in seconds.

AttrEdgeStatusCodeCacheTtl^Required

public object AttrEdgeStatusCodeCacheTtl { get; }

• Type: object

Attribute EdgeStatusCodeCacheTtl: Status code cache expiration time in seconds.

AttrIncludeCookie^Required

public object AttrIncludeCookie { get; }

• Type: object

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 object AttrIncludeHeader { get; }

• Type: object

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 object AttrQueryString { get; }

• Type: object

Attribute QueryString: Query strings to be reserved or excluded.

Multiple values are supported, separated by spaces.

AttrQueryStringMode^Required

public object AttrQueryStringMode { get; }

• Type: object

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

AttrRule^Required

public object AttrRule { get; }

• Type: object

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 object AttrRuleEnable { get; }

• Type: object

Attribute RuleEnable: Rule switch.

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

AttrRuleName^Required

public object AttrRuleName { get; }

• Type: object

Attribute RuleName: Rule name.

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

AttrSequence^Required

public object AttrSequence { get; }

• Type: object

Attribute Sequence: Order of rule execution.

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

AttrServeStale^Required

public object AttrServeStale { get; }

• Type: object

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 object AttrSiteVersion { get; }

• Type: object

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 object AttrSortQueryStringForCache { get; }

• Type: object

Attribute SortQueryStringForCache: Query string sorting, disabled by default.

AttrUserDeviceType^Required

public object AttrUserDeviceType { get; }

• Type: object

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

AttrUserGeo^Required

public object AttrUserGeo { get; }

• Type: object

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

AttrUserLanguage^Required

public object AttrUserLanguage { get; }

• Type: object

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

Props^Required

public CacheRuleProps Props { get; }

• Type: CacheRuleProps