RosCacheRule

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkesa"
alicloudroscdkesa.NewRosCacheRule(scope Construct, id *string, props RosCacheRuleProps, enableResourcePropertyConstraint *bool) RosCacheRule

scope^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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: *bool

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func AddCondition(con RosCondition)

con^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

AddDeletionOverride

func AddDeletionOverride(path *string)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: *string

The path of the value to delete.

AddDependsOn

func AddDependsOn(target RosResource)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AddDesc

func AddDesc(desc *string)

desc^Required

• Type: *string

AddMetaData

func AddMetaData(key *string, value interface{})

key^Required

• Type: *string

value^Required

• Type: interface{}

AddOverride

func AddOverride(path *string, value interface{})

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: interface{}

The value.

Could be primitive or complex.

AddPropertyDeletionOverride

func AddPropertyDeletionOverride(propertyPath *string)

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

propertyPath^Required

• Type: *string

The path to the property.

AddPropertyOverride

func AddPropertyOverride(propertyPath *string, value interface{})

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: interface{}

The value.

AddRosDependency

func AddRosDependency(target *string)

target^Required

• Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy, options RemovalPolicyOptions)

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

policy^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

options^Optional

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicyOptions

FetchCondition

func FetchCondition() RosCondition

FetchDesc

func FetchDesc() *string

FetchRosDependency

func FetchRosDependency() *[]*string

GetAtt

func 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 "github.com/alibabacloud-go/ros-cdk/alicloudroscdkesa"
alicloudroscdkesa.RosCacheRule_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

IsRosElement

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkesa"
alicloudroscdkesa.RosCacheRule_IsRosElement(x interface{}) *bool

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: interface{}

IsRosResource

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkesa"
alicloudroscdkesa.RosCacheRule_IsRosResource(construct IConstruct) *bool

Check whether the given construct is a RosResource.

construct^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IConstruct

Properties

Node^Required

func Node() ConstructNode

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

CreationStack^Required

func CreationStack() *[]*string

• Type: []string

LogicalId^Required

func 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

func Stack() Stack

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this element is defined.

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

Ref^Required

func 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

func RosOptions() IRosResourceOptions

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IRosResourceOptions

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

RosResourceType^Required

func RosResourceType() *string

• Type: *string

ROS resource type.

AttrAdditionalCacheablePorts^Required

func AttrAdditionalCacheablePorts() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrBrowserCacheMode^Required

func AttrBrowserCacheMode() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrBrowserCacheTtl^Required

func AttrBrowserCacheTtl() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrBypassCache^Required

func AttrBypassCache() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCacheDeceptionArmor^Required

func AttrCacheDeceptionArmor() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCacheReserveEligibility^Required

func AttrCacheReserveEligibility() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCacheRuleId^Required

func AttrCacheRuleId() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCheckPresenceCookie^Required

func AttrCheckPresenceCookie() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrCheckPresenceHeader^Required

func AttrCheckPresenceHeader() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrConfigType^Required

func AttrConfigType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEdgeCacheMode^Required

func AttrEdgeCacheMode() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEdgeCacheTtl^Required

func AttrEdgeCacheTtl() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrEdgeStatusCodeCacheTtl^Required

func AttrEdgeStatusCodeCacheTtl() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIncludeCookie^Required

func AttrIncludeCookie() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrIncludeHeader^Required

func AttrIncludeHeader() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrQueryString^Required

func AttrQueryString() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrQueryStringMode^Required

func AttrQueryStringMode() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrRule^Required

func AttrRule() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrRuleEnable^Required

func AttrRuleEnable() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrRuleName^Required

func AttrRuleName() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSequence^Required

func AttrSequence() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrServeStale^Required

func AttrServeStale() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSiteVersion^Required

func AttrSiteVersion() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrSortQueryStringForCache^Required

func AttrSortQueryStringForCache() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrUserDeviceType^Required

func AttrUserDeviceType() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrUserGeo^Required

func AttrUserGeo() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

AttrUserLanguage^Required

func AttrUserLanguage() IResolvable

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

EnableResourcePropertyConstraint^Required

func EnableResourcePropertyConstraint() *bool

• Type: *bool

SiteId^Required

func SiteId() interface{}

• Type: interface{}

AdditionalCacheablePorts^Optional

func AdditionalCacheablePorts() interface{}

• Type: interface{}

BrowserCacheMode^Optional

func BrowserCacheMode() interface{}

• Type: interface{}

BrowserCacheTtl^Optional

func BrowserCacheTtl() interface{}

• Type: interface{}

BypassCache^Optional

func BypassCache() interface{}

• Type: interface{}

CacheDeceptionArmor^Optional

func CacheDeceptionArmor() interface{}

• Type: interface{}

CacheReserveEligibility^Optional

func CacheReserveEligibility() interface{}

• Type: interface{}

CheckPresenceCookie^Optional

func CheckPresenceCookie() interface{}

• Type: interface{}

CheckPresenceHeader^Optional

func CheckPresenceHeader() interface{}

• Type: interface{}

EdgeCacheMode^Optional

func EdgeCacheMode() interface{}

• Type: interface{}

EdgeCacheTtl^Optional

func EdgeCacheTtl() interface{}

• Type: interface{}

EdgeStatusCodeCacheTtl^Optional

func EdgeStatusCodeCacheTtl() interface{}

• Type: interface{}

IncludeCookie^Optional

func IncludeCookie() interface{}

• Type: interface{}

IncludeHeader^Optional

func IncludeHeader() interface{}

• Type: interface{}

QueryString^Optional

func QueryString() interface{}

• Type: interface{}

QueryStringMode^Optional

func QueryStringMode() interface{}

• Type: interface{}

Rule^Optional

func Rule() interface{}

• Type: interface{}

RuleEnable^Optional

func RuleEnable() interface{}

• Type: interface{}

RuleName^Optional

func RuleName() interface{}

• Type: interface{}

Sequence^Optional

func Sequence() interface{}

• Type: interface{}

ServeStale^Optional

func ServeStale() interface{}

• Type: interface{}

SiteVersion^Optional

func SiteVersion() interface{}

• Type: interface{}

SortQueryStringForCache^Optional

func SortQueryStringForCache() interface{}

• Type: interface{}

UserDeviceType^Optional

func UserDeviceType() interface{}

• Type: interface{}

UserGeo^Optional

func UserGeo() interface{}

• Type: interface{}

UserLanguage^Optional

func UserLanguage() interface{}

• Type: interface{}

Constants

RosResourceTypeName^Required

func RosResourceTypeName() *string

• Type: *string

The resource type name for this resource class.