Skip to content

GatewayRouteProps

Properties for defining a GatewayRoute.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mse-gatewayroute

Initializer

import ros_cdk_mse
ros_cdk_mse.GatewayRouteProps(
  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
)

Properties

Name Type Description
domain_id_list 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 typing.Union[str, ros_cdk_core.IResolvable] Property gatewayUniqueId: The unique ID of the gateway.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the route.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the route.
destination_type typing.Union[str, ros_cdk_core.IResolvable] Property destinationType: The type of destination service.
direct_response_json typing.Union[ros_cdk_core.IResolvable, DirectResponseJSONProperty] Property directResponseJson: Configuration for mock response.
domain_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property domainId: The ID of the domain.
fallback typing.Union[bool, ros_cdk_core.IResolvable] Property fallback: Whether to enable fallback service.
fallback_services typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, FallbackServicesProperty]]] Property fallbackServices: The list of fallback services.
gateway_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property gatewayId: The ID of the gateway.
policies typing.Union[str, ros_cdk_core.IResolvable] Property policies: The JSON string of route policies.
predicates typing.Union[ros_cdk_core.IResolvable, PredicatesProperty] Property predicates: Matching rules for the route.
redirect_json typing.Union[ros_cdk_core.IResolvable, RedirectJSONProperty] Property redirectJson: Configuration for redirect.
route_order typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property routeOrder: The order of the route.
route_type typing.Union[str, ros_cdk_core.IResolvable] Property routeType: The type of the route.
services typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ServicesProperty]]] Property services: The list of backend services.

domain_id_listRequired

domain_id_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • 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_idRequired

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

Property gatewayUniqueId: The unique ID of the gateway.


nameRequired

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

Property name: The name of the route.


descriptionOptional

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

Property description: The description of the route.


destination_typeOptional

destination_type: typing.Union[str, IResolvable]
  • 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_jsonOptional

direct_response_json: typing.Union[IResolvable, DirectResponseJSONProperty]

Property directResponseJson: Configuration for mock response.


domain_idOptional

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

Property domainId: The ID of the domain.


fallbackOptional

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

Property fallback: Whether to enable fallback service.


fallback_servicesOptional

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

Property fallbackServices: The list of fallback services.


gateway_idOptional

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

Property gatewayId: The ID of the gateway.


policiesOptional

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

Property policies: The JSON string of route policies.


predicatesOptional

predicates: typing.Union[IResolvable, PredicatesProperty]

Property predicates: Matching rules for the route.


redirect_jsonOptional

redirect_json: typing.Union[IResolvable, RedirectJSONProperty]

Property redirectJson: Configuration for redirect.


route_orderOptional

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

Property routeOrder: The order of the route.

Smaller values indicate higher priority.


route_typeOptional

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

Property routeType: The type of the route.

Valid value: Op (control route).


servicesOptional

services: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServicesProperty]]]
  • 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.