Skip to content

RouteProps

Properties for defining a Route.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-route

Initializer 

import ros_cdk_apig
ros_cdk_apig.RouteProps(
  backend: typing.Union[IResolvable, BackendProperty],
  environment_info: typing.Union[IResolvable, EnvironmentInfoProperty],
  http_api_id: typing.Union[str, IResolvable],
  match: typing.Union[IResolvable, MatchProperty],
  route_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  domain_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  domain_infos: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DomainInfosProperty]]] = None
)

Properties

Name Type Description
backend typing.Union[ros_cdk_core.IResolvable, BackendProperty] Property backend: Backend service configuration for routing.
environment_info typing.Union[ros_cdk_core.IResolvable, EnvironmentInfoProperty] Property environmentInfo: The information if the environment.
http_api_id typing.Union[str, ros_cdk_core.IResolvable] Property httpApiId: The ID of the API.
match typing.Union[ros_cdk_core.IResolvable, MatchProperty] Property match: The match rule of route resource.
route_name typing.Union[str, ros_cdk_core.IResolvable] Property routeName: The name of the route.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of route.
domain_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property domainIds: The list of domain name IDs.
domain_infos typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DomainInfosProperty]]] Property domainInfos: Domain items.

backendRequired 

backend: typing.Union[IResolvable, BackendProperty]

Property backend: Backend service configuration for routing.

environment_infoRequired 

environment_info: typing.Union[IResolvable, EnvironmentInfoProperty]

Property environmentInfo: The information if the environment.

http_api_idRequired 

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

Property httpApiId: The ID of the API.

matchRequired 

match: typing.Union[IResolvable, MatchProperty]

Property match: The match rule of route resource.

route_nameRequired 

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

Property routeName: The name of the route.

descriptionOptional 

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

Property description: The description of route.

domain_idsOptional 

domain_ids: 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 domainIds: The list of domain name IDs.

domain_infosOptional 

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

Property domainInfos: Domain items.