RosCacheRule

This class is a base encapsulation around the ROS resource type ALIYUN::ESA::CacheRule.

Initializers

import com.aliyun.ros.cdk.esa.RosCacheRule;
RosCacheRule.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

scope in which this resource is defined.

id^Required

• Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

siteId^Required

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

additionalCacheablePorts^Optional

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

browserCacheMode^Optional

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

browserCacheTtl^Optional

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

bypassCache^Optional

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

cacheDeceptionArmor^Optional

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

cacheReserveEligibility^Optional

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

checkPresenceCookie^Optional

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

checkPresenceHeader^Optional

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

edgeCacheMode^Optional

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

edgeCacheTtl^Optional

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

edgeStatusCodeCacheTtl^Optional

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

includeCookie^Optional

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

includeHeader^Optional

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

queryString^Optional

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

queryStringMode^Optional

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

rule^Optional

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

ruleEnable^Optional

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

ruleName^Optional

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

sequence^Optional

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

serveStale^Optional

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

siteVersion^Optional

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

sortQueryStringForCache^Optional

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

userDeviceType^Optional

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

userGeo^Optional

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

userLanguage^Optional

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

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.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

addCondition

public void addCondition(RosCondition con)

con^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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: java.lang.String

The path of the value to delete.

addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

addMetaData

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: java.lang.String

The path to the property.

addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: java.lang.String

The path of the property.

value^Required

• Type: java.lang.Object

The value.

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

options^Optional

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

fetchCondition

public RosCondition fetchCondition()

fetchDesc

public java.lang.String fetchDesc()

fetchRosDependency

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

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: java.lang.String

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.esa.RosCacheRule;
RosCacheRule.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.esa.RosCacheRule;
RosCacheRule.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

creationStack^Required

public java.util.List<java.lang.String> getCreationStack();

• Type: java.util.List

logicalId^Required

public java.lang.String getLogicalId();

• Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

public Stack getStack();

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

Options for this resource, such as condition, update policy etc.

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

attrAdditionalCacheablePorts^Required

public IResolvable getAttrAdditionalCacheablePorts();

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

attrBrowserCacheMode^Required

public IResolvable getAttrBrowserCacheMode();

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

attrBrowserCacheTtl^Required

public IResolvable getAttrBrowserCacheTtl();

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

attrBypassCache^Required

public IResolvable getAttrBypassCache();

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

attrCacheDeceptionArmor^Required

public IResolvable getAttrCacheDeceptionArmor();

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

attrCacheReserveEligibility^Required

public IResolvable getAttrCacheReserveEligibility();

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

attrCacheRuleId^Required

public IResolvable getAttrCacheRuleId();

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

attrCheckPresenceCookie^Required

public IResolvable getAttrCheckPresenceCookie();

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

attrCheckPresenceHeader^Required

public IResolvable getAttrCheckPresenceHeader();

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

attrConfigType^Required

public IResolvable getAttrConfigType();

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

attrEdgeCacheMode^Required

public IResolvable getAttrEdgeCacheMode();

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

attrEdgeCacheTtl^Required

public IResolvable getAttrEdgeCacheTtl();

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

attrEdgeStatusCodeCacheTtl^Required

public IResolvable getAttrEdgeStatusCodeCacheTtl();

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

attrIncludeCookie^Required

public IResolvable getAttrIncludeCookie();

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

attrIncludeHeader^Required

public IResolvable getAttrIncludeHeader();

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

attrQueryString^Required

public IResolvable getAttrQueryString();

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

attrQueryStringMode^Required

public IResolvable getAttrQueryStringMode();

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

attrRule^Required

public IResolvable getAttrRule();

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

attrRuleEnable^Required

public IResolvable getAttrRuleEnable();

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

attrRuleName^Required

public IResolvable getAttrRuleName();

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

attrSequence^Required

public IResolvable getAttrSequence();

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

attrServeStale^Required

public IResolvable getAttrServeStale();

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

attrSiteVersion^Required

public IResolvable getAttrSiteVersion();

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

attrSortQueryStringForCache^Required

public IResolvable getAttrSortQueryStringForCache();

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

attrUserDeviceType^Required

public IResolvable getAttrUserDeviceType();

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

attrUserGeo^Required

public IResolvable getAttrUserGeo();

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

attrUserLanguage^Required

public IResolvable getAttrUserLanguage();

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

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

siteId^Required

public java.lang.Object getSiteId();

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

additionalCacheablePorts^Optional

public java.lang.Object getAdditionalCacheablePorts();

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

browserCacheMode^Optional

public java.lang.Object getBrowserCacheMode();

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

browserCacheTtl^Optional

public java.lang.Object getBrowserCacheTtl();

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

bypassCache^Optional

public java.lang.Object getBypassCache();

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

cacheDeceptionArmor^Optional

public java.lang.Object getCacheDeceptionArmor();

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

cacheReserveEligibility^Optional

public java.lang.Object getCacheReserveEligibility();

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

checkPresenceCookie^Optional

public java.lang.Object getCheckPresenceCookie();

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

checkPresenceHeader^Optional

public java.lang.Object getCheckPresenceHeader();

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

edgeCacheMode^Optional

public java.lang.Object getEdgeCacheMode();

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

edgeCacheTtl^Optional

public java.lang.Object getEdgeCacheTtl();

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

edgeStatusCodeCacheTtl^Optional

public java.lang.Object getEdgeStatusCodeCacheTtl();

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

includeCookie^Optional

public java.lang.Object getIncludeCookie();

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

includeHeader^Optional

public java.lang.Object getIncludeHeader();

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

queryString^Optional

public java.lang.Object getQueryString();

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

queryStringMode^Optional

public java.lang.Object getQueryStringMode();

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

rule^Optional

public java.lang.Object getRule();

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

ruleEnable^Optional

public java.lang.Object getRuleEnable();

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

ruleName^Optional

public java.lang.Object getRuleName();

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

sequence^Optional

public java.lang.Object getSequence();

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

serveStale^Optional

public java.lang.Object getServeStale();

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

siteVersion^Optional

public java.lang.Object getSiteVersion();

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

sortQueryStringForCache^Optional

public java.lang.Object getSortQueryStringForCache();

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

userDeviceType^Optional

public java.lang.Object getUserDeviceType();

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

userGeo^Optional

public java.lang.Object getUserGeo();

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

userLanguage^Optional

public java.lang.Object getUserLanguage();

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.