RosCacheRule

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

Initializers

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

scope^Required

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

scope in which this resource is defined.

id^Required

• Type: string

scoped id of the resource.

props^Required

• Type: RosCacheRuleProps

resource properties.

enableResourcePropertyConstraint^Required

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

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

addCondition

public addCondition(con: RosCondition): void

con^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: string

The path of the value to delete.

addDependsOn

public addDependsOn(target: RosResource): void

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

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

addMetaData

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

key^Required

• Type: string

value^Required

• Type: any

addOverride

public addOverride(path: string, value: any): void

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: 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: any

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public addPropertyDeletionOverride(propertyPath: string): void

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

propertyPath^Required

• Type: string

The path to the property.

addPropertyOverride

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

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

propertyPath^Required

• Type: string

The path of the property.

value^Required

• Type: any

The value.

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

applyRemovalPolicy

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

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

policy^Optional

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

options^Optional

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

fetchCondition

public fetchCondition(): RosCondition

fetchDesc

public fetchDesc(): string

fetchRosDependency

public fetchRosDependency(): string[]

getAtt

public getAtt(attributeName: string): Reference

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: string

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

isRosElement

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

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: any

isRosResource

import { RosCacheRule } from '@alicloud/ros-cdk-esa'
RosCacheRule.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

logicalId^Required

public readonly logicalId: string;

• Type: 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 readonly stack: Stack;

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

• Type: 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 readonly rosOptions: IRosResourceOptions;

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

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

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

attrAdditionalCacheablePorts^Required

public readonly attrAdditionalCacheablePorts: IResolvable;

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

attrBrowserCacheMode^Required

public readonly attrBrowserCacheMode: IResolvable;

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

attrBrowserCacheTtl^Required

public readonly attrBrowserCacheTtl: IResolvable;

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

attrBypassCache^Required

public readonly attrBypassCache: IResolvable;

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

attrCacheDeceptionArmor^Required

public readonly attrCacheDeceptionArmor: IResolvable;

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

attrCacheReserveEligibility^Required

public readonly attrCacheReserveEligibility: IResolvable;

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

attrCacheRuleId^Required

public readonly attrCacheRuleId: IResolvable;

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

attrCheckPresenceCookie^Required

public readonly attrCheckPresenceCookie: IResolvable;

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

attrCheckPresenceHeader^Required

public readonly attrCheckPresenceHeader: IResolvable;

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

attrConfigType^Required

public readonly attrConfigType: IResolvable;

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

attrEdgeCacheMode^Required

public readonly attrEdgeCacheMode: IResolvable;

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

attrEdgeCacheTtl^Required

public readonly attrEdgeCacheTtl: IResolvable;

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

attrEdgeStatusCodeCacheTtl^Required

public readonly attrEdgeStatusCodeCacheTtl: IResolvable;

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

attrIncludeCookie^Required

public readonly attrIncludeCookie: IResolvable;

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

attrIncludeHeader^Required

public readonly attrIncludeHeader: IResolvable;

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

attrQueryString^Required

public readonly attrQueryString: IResolvable;

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

attrQueryStringMode^Required

public readonly attrQueryStringMode: IResolvable;

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

attrRule^Required

public readonly attrRule: IResolvable;

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

attrRuleEnable^Required

public readonly attrRuleEnable: IResolvable;

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

attrRuleName^Required

public readonly attrRuleName: IResolvable;

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

attrSequence^Required

public readonly attrSequence: IResolvable;

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

attrServeStale^Required

public readonly attrServeStale: IResolvable;

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

attrSiteVersion^Required

public readonly attrSiteVersion: IResolvable;

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

attrSortQueryStringForCache^Required

public readonly attrSortQueryStringForCache: IResolvable;

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

attrUserDeviceType^Required

public readonly attrUserDeviceType: IResolvable;

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

attrUserGeo^Required

public readonly attrUserGeo: IResolvable;

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

attrUserLanguage^Required

public readonly attrUserLanguage: IResolvable;

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

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

siteId^Required

public readonly siteId: number | IResolvable;

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

additionalCacheablePorts^Optional

public readonly additionalCacheablePorts: number | IResolvable;

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

browserCacheMode^Optional

public readonly browserCacheMode: string | IResolvable;

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

browserCacheTtl^Optional

public readonly browserCacheTtl: number | IResolvable;

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

bypassCache^Optional

public readonly bypassCache: string | IResolvable;

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

cacheDeceptionArmor^Optional

public readonly cacheDeceptionArmor: string | IResolvable;

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

cacheReserveEligibility^Optional

public readonly cacheReserveEligibility: string | IResolvable;

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

checkPresenceCookie^Optional

public readonly checkPresenceCookie: string | IResolvable;

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

checkPresenceHeader^Optional

public readonly checkPresenceHeader: string | IResolvable;

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

edgeCacheMode^Optional

public readonly edgeCacheMode: string | IResolvable;

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

edgeCacheTtl^Optional

public readonly edgeCacheTtl: number | IResolvable;

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

edgeStatusCodeCacheTtl^Optional

public readonly edgeStatusCodeCacheTtl: string | IResolvable;

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

includeCookie^Optional

public readonly includeCookie: string | IResolvable;

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

includeHeader^Optional

public readonly includeHeader: string | IResolvable;

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

queryString^Optional

public readonly queryString: string | IResolvable;

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

queryStringMode^Optional

public readonly queryStringMode: string | IResolvable;

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

rule^Optional

public readonly rule: string | IResolvable;

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

ruleEnable^Optional

public readonly ruleEnable: string | IResolvable;

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

ruleName^Optional

public readonly ruleName: string | IResolvable;

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

sequence^Optional

public readonly sequence: number | IResolvable;

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

serveStale^Optional

public readonly serveStale: string | IResolvable;

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

siteVersion^Optional

public readonly siteVersion: number | IResolvable;

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

sortQueryStringForCache^Optional

public readonly sortQueryStringForCache: string | IResolvable;

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

userDeviceType^Optional

public readonly userDeviceType: string | IResolvable;

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

userGeo^Optional

public readonly userGeo: string | IResolvable;

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

userLanguage^Optional

public readonly userLanguage: string | IResolvable;

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.