RosCacheRule

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

Initializers

import ros_cdk_esa
ros_cdk_esa.RosCacheRule(
  scope: Construct,
  id: str,
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  additional_cacheable_ports: typing.Union[typing.Union[int, float], IResolvable] = None,
  browser_cache_mode: typing.Union[str, IResolvable] = None,
  browser_cache_ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  bypass_cache: typing.Union[str, IResolvable] = None,
  cache_deception_armor: typing.Union[str, IResolvable] = None,
  cache_reserve_eligibility: typing.Union[str, IResolvable] = None,
  check_presence_cookie: typing.Union[str, IResolvable] = None,
  check_presence_header: typing.Union[str, IResolvable] = None,
  edge_cache_mode: typing.Union[str, IResolvable] = None,
  edge_cache_ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  edge_status_code_cache_ttl: typing.Union[str, IResolvable] = None,
  include_cookie: typing.Union[str, IResolvable] = None,
  include_header: typing.Union[str, IResolvable] = None,
  query_string: typing.Union[str, IResolvable] = None,
  query_string_mode: typing.Union[str, IResolvable] = None,
  rule: typing.Union[str, IResolvable] = None,
  rule_enable: typing.Union[str, IResolvable] = None,
  rule_name: typing.Union[str, IResolvable] = None,
  sequence: typing.Union[typing.Union[int, float], IResolvable] = None,
  serve_stale: typing.Union[str, IResolvable] = None,
  site_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  sort_query_string_for_cache: typing.Union[str, IResolvable] = None,
  user_device_type: typing.Union[str, IResolvable] = None,
  user_geo: typing.Union[str, IResolvable] = None,
  user_language: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool
)

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

id^Required

• Type: str

scoped id of the resource.

site_id^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

additional_cacheable_ports^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

browser_cache_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

browser_cache_ttl^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

bypass_cache^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

cache_deception_armor^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

cache_reserve_eligibility^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

check_presence_cookie^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

check_presence_header^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

edge_cache_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

edge_cache_ttl^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

edge_status_code_cache_ttl^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

include_cookie^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

include_header^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

query_string^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

query_string_mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule_enable^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sequence^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

serve_stale^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

site_version^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

sort_query_string_for_cache^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_device_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_geo^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_language^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

enable_resource_property_constraint^Required

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

add_condition

def add_condition(
  con: RosCondition
) -> None

con^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

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: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

add_meta_data

def add_meta_data(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

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

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: typing.Any

The value.

Could be primitive or complex.

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

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

property_path^Required

• Type: str

The path to the property.

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

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

property_path^Required

• Type: str

The path of the property.

value^Required

• Type: typing.Any

The value.

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

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

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policy^Optional

• Type: bool

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_desc

def fetch_desc() -> str

fetch_ros_dependency

def fetch_ros_dependency() -> typing.List[str]

get_att

def get_att(
  attribute_name: str
) -> 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.

attribute_name^Required

• Type: str

The name of the attribute.

Static Functions

is_construct

import ros_cdk_esa
ros_cdk_esa.RosCacheRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

is_ros_element

import ros_cdk_esa
ros_cdk_esa.RosCacheRule.is_ros_element(
  x: typing.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: typing.Any

is_ros_resource

import ros_cdk_esa
ros_cdk_esa.RosCacheRule.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

logical_id^Required

logical_id: str

• Type: str

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

stack: Stack

• Type: 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

ref: str

• Type: str

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 }).

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

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

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

attr_additional_cacheable_ports^Required

attr_additional_cacheable_ports: IResolvable

• Type: ros_cdk_core.IResolvable

attr_browser_cache_mode^Required

attr_browser_cache_mode: IResolvable

• Type: ros_cdk_core.IResolvable

attr_browser_cache_ttl^Required

attr_browser_cache_ttl: IResolvable

• Type: ros_cdk_core.IResolvable

attr_bypass_cache^Required

attr_bypass_cache: IResolvable

• Type: ros_cdk_core.IResolvable

attr_cache_deception_armor^Required

attr_cache_deception_armor: IResolvable

• Type: ros_cdk_core.IResolvable

attr_cache_reserve_eligibility^Required

attr_cache_reserve_eligibility: IResolvable

• Type: ros_cdk_core.IResolvable

attr_cache_rule_id^Required

attr_cache_rule_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_check_presence_cookie^Required

attr_check_presence_cookie: IResolvable

• Type: ros_cdk_core.IResolvable

attr_check_presence_header^Required

attr_check_presence_header: IResolvable

• Type: ros_cdk_core.IResolvable

attr_config_type^Required

attr_config_type: IResolvable

• Type: ros_cdk_core.IResolvable

attr_edge_cache_mode^Required

attr_edge_cache_mode: IResolvable

• Type: ros_cdk_core.IResolvable

attr_edge_cache_ttl^Required

attr_edge_cache_ttl: IResolvable

• Type: ros_cdk_core.IResolvable

attr_edge_status_code_cache_ttl^Required

attr_edge_status_code_cache_ttl: IResolvable

• Type: ros_cdk_core.IResolvable

attr_include_cookie^Required

attr_include_cookie: IResolvable

• Type: ros_cdk_core.IResolvable

attr_include_header^Required

attr_include_header: IResolvable

• Type: ros_cdk_core.IResolvable

attr_query_string^Required

attr_query_string: IResolvable

• Type: ros_cdk_core.IResolvable

attr_query_string_mode^Required

attr_query_string_mode: IResolvable

• Type: ros_cdk_core.IResolvable

attr_rule^Required

attr_rule: IResolvable

• Type: ros_cdk_core.IResolvable

attr_rule_enable^Required

attr_rule_enable: IResolvable

• Type: ros_cdk_core.IResolvable

attr_rule_name^Required

attr_rule_name: IResolvable

• Type: ros_cdk_core.IResolvable

attr_sequence^Required

attr_sequence: IResolvable

• Type: ros_cdk_core.IResolvable

attr_serve_stale^Required

attr_serve_stale: IResolvable

• Type: ros_cdk_core.IResolvable

attr_site_version^Required

attr_site_version: IResolvable

• Type: ros_cdk_core.IResolvable

attr_sort_query_string_for_cache^Required

attr_sort_query_string_for_cache: IResolvable

• Type: ros_cdk_core.IResolvable

attr_user_device_type^Required

attr_user_device_type: IResolvable

• Type: ros_cdk_core.IResolvable

attr_user_geo^Required

attr_user_geo: IResolvable

• Type: ros_cdk_core.IResolvable

attr_user_language^Required

attr_user_language: IResolvable

• Type: ros_cdk_core.IResolvable

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

site_id^Required

site_id: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

additional_cacheable_ports^Optional

additional_cacheable_ports: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

browser_cache_mode^Optional

browser_cache_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

browser_cache_ttl^Optional

browser_cache_ttl: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

bypass_cache^Optional

bypass_cache: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

cache_deception_armor^Optional

cache_deception_armor: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

cache_reserve_eligibility^Optional

cache_reserve_eligibility: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

check_presence_cookie^Optional

check_presence_cookie: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

check_presence_header^Optional

check_presence_header: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

edge_cache_mode^Optional

edge_cache_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

edge_cache_ttl^Optional

edge_cache_ttl: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

edge_status_code_cache_ttl^Optional

edge_status_code_cache_ttl: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

include_cookie^Optional

include_cookie: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

include_header^Optional

include_header: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

query_string^Optional

query_string: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

query_string_mode^Optional

query_string_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule^Optional

rule: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule_enable^Optional

rule_enable: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

rule_name^Optional

rule_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

sequence^Optional

sequence: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

serve_stale^Optional

serve_stale: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

site_version^Optional

site_version: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

sort_query_string_for_cache^Optional

sort_query_string_for_cache: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_device_type^Optional

user_device_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_geo^Optional

user_geo: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

user_language^Optional

user_language: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Constants

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.