RoutineRoute

• Implements: IRoutineRoute

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

Initializers

import ros_cdk_esa
ros_cdk_esa.RoutineRoute(
  scope: Construct,
  id: str,
  routine_name: typing.Union[str, IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  bypass: typing.Union[str, IResolvable] = None,
  fallback: typing.Union[str, IResolvable] = None,
  route_enable: typing.Union[str, IResolvable] = None,
  route_name: typing.Union[str, IResolvable] = None,
  rule: typing.Union[str, IResolvable] = None,
  sequence: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

routine_name^Required

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

Property routineName: The edge function Routine name.

site_id^Required

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

Property siteId: The website ID.

bypass^Optional

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

Property bypass: Bypass mode.

Value range:

• on: Open
• off: off.

fallback^Optional

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

Property fallback: The exception origin fetch switch.

After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values: on off

route_enable^Optional

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

Property routeEnable: Routing switch.

Value range:

• on: Open
• off: off.

route_name^Optional

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

Property routeName: The name of the route.

rule^Optional

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

Property rule: The content of the rule.

sequence^Optional

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

Property sequence: Rule execution order.

enable_resource_property_constraint^Optional

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

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^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_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

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

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_bypass^Required

attr_bypass: typing.Union[str, IResolvable]

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

Attribute Bypass: Bypass mode.

attr_config_id^Required

attr_config_id: typing.Union[str, IResolvable]

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

Attribute ConfigId: The configuration ID.

attr_config_type^Required

attr_config_type: typing.Union[str, IResolvable]

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

Attribute ConfigType: The configuration type.

You can use this parameter to check the global configuration or rule configuration.

attr_fallback^Required

attr_fallback: typing.Union[str, IResolvable]

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

Attribute Fallback: An exception to the origin server switch will be enabled.

If an exception occurs in the function, such as CPU usage exceeding limits, a request will be made to return to the origin server.

attr_mode^Required

attr_mode: typing.Union[str, IResolvable]

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

Attribute Mode: Configuration mode.

attr_route_enable^Required

attr_route_enable: typing.Union[str, IResolvable]

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

Attribute RouteEnable: Routing switch.

attr_route_name^Required

attr_route_name: typing.Union[str, IResolvable]

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

Attribute RouteName: The route name.

attr_routine_name^Required

attr_routine_name: typing.Union[str, IResolvable]

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

Attribute RoutineName: The edge function Routine name.

attr_rule^Required

attr_rule: typing.Union[str, IResolvable]

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

Attribute Rule: The content of the rule.

attr_sequence^Required

attr_sequence: typing.Union[str, IResolvable]

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

Attribute Sequence: Rule execution order.

attr_site_version^Required

attr_site_version: typing.Union[str, IResolvable]

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

Attribute SiteVersion: Version number of the site.

props^Required

props: RoutineRouteProps

• Type: RoutineRouteProps