GatewayRoute

• Implements: IGatewayRoute

This class encapsulates and extends the ROS resource type ALIYUN::MSE::GatewayRoute.

Initializers

import ros_cdk_mse
ros_cdk_mse.GatewayRoute(
  scope: Construct,
  id: str,
  domain_id_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  gateway_unique_id: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  destination_type: typing.Union[str, IResolvable] = None,
  direct_response_json: typing.Union[IResolvable, DirectResponseJSONProperty] = None,
  domain_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  fallback: typing.Union[bool, IResolvable] = None,
  fallback_services: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, FallbackServicesProperty]]] = None,
  gateway_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  policies: typing.Union[str, IResolvable] = None,
  predicates: typing.Union[IResolvable, PredicatesProperty] = None,
  redirect_json: typing.Union[IResolvable, RedirectJSONProperty] = None,
  route_order: typing.Union[typing.Union[int, float], IResolvable] = None,
  route_type: typing.Union[str, IResolvable] = None,
  services: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServicesProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

domain_id_list^Required

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

Property domainIdList: The list of domain IDs in JSON format.

gateway_unique_id^Required

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

Property gatewayUniqueId: The unique ID of the gateway.

name^Required

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

Property name: The name of the route.

description^Optional

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

Property description: The description of the route.

destination_type^Optional

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

Property destinationType: The type of destination service.

Valid values:

• Single: single service
• Multiple: multiple services
• VersionOriented: tag-based routing
• Mock: mock response
• Redirect: redirect

direct_response_json^Optional

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

Property directResponseJson: Configuration for mock response.

domain_id^Optional

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

Property domainId: The ID of the domain.

fallback^Optional

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

Property fallback: Whether to enable fallback service.

fallback_services^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, FallbackServicesProperty]]]

Property fallbackServices: The list of fallback services.

gateway_id^Optional

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

Property gatewayId: The ID of the gateway.

policies^Optional

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

Property policies: The JSON string of route policies.

predicates^Optional

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

Property predicates: Matching rules for the route.

redirect_json^Optional

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

Property redirectJson: Configuration for redirect.

route_order^Optional

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

Property routeOrder: The order of the route.

Smaller values indicate higher priority.

route_type^Optional

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

Property routeType: The type of the route.

Valid value: Op (control route).

services^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServicesProperty]]]

Property services: The list of backend services.

Required when DestinationType is Single, Multiple, or VersionOriented.

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_mse
ros_cdk_mse.GatewayRoute.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_route_id^Required

attr_route_id: typing.Union[str, IResolvable]

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

Attribute RouteId: The ID of the route.

props^Required

props: GatewayRouteProps

• Type: GatewayRouteProps