Skip to content

GatewayRouteProps

Properties for defining a GatewayRoute.

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

Initializer

import { GatewayRouteProps } from '@alicloud/ros-cdk-mse'
const gatewayRouteProps: GatewayRouteProps = { ... }

Properties

Name Type Description
domainIdList @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property domainIdList: The list of domain IDs in JSON format.
gatewayUniqueId string | @alicloud/ros-cdk-core.IResolvable Property gatewayUniqueId: The unique ID of the gateway.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the route.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the route.
destinationType string | @alicloud/ros-cdk-core.IResolvable Property destinationType: The type of destination service.
directResponseJson @alicloud/ros-cdk-core.IResolvable | DirectResponseJSONProperty Property directResponseJson: Configuration for mock response.
domainId number | @alicloud/ros-cdk-core.IResolvable Property domainId: The ID of the domain.
fallback boolean | @alicloud/ros-cdk-core.IResolvable Property fallback: Whether to enable fallback service.
fallbackServices @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | FallbackServicesProperty[] Property fallbackServices: The list of fallback services.
gatewayId number | @alicloud/ros-cdk-core.IResolvable Property gatewayId: The ID of the gateway.
policies string | @alicloud/ros-cdk-core.IResolvable Property policies: The JSON string of route policies.
predicates @alicloud/ros-cdk-core.IResolvable | PredicatesProperty Property predicates: Matching rules for the route.
redirectJson @alicloud/ros-cdk-core.IResolvable | RedirectJSONProperty Property redirectJson: Configuration for redirect.
routeOrder number | @alicloud/ros-cdk-core.IResolvable Property routeOrder: The order of the route.
routeType string | @alicloud/ros-cdk-core.IResolvable Property routeType: The type of the route.
services @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ServicesProperty[] Property services: The list of backend services.

domainIdListRequired

public readonly domainIdList: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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


gatewayUniqueIdRequired

public readonly gatewayUniqueId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property gatewayUniqueId: The unique ID of the gateway.


nameRequired

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the route.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the route.


destinationTypeOptional

public readonly destinationType: string | IResolvable;
  • Type: string | @alicloud/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


directResponseJsonOptional

public readonly directResponseJson: IResolvable | DirectResponseJSONProperty;

Property directResponseJson: Configuration for mock response.


domainIdOptional

public readonly domainId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property domainId: The ID of the domain.


fallbackOptional

public readonly fallback: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property fallback: Whether to enable fallback service.


fallbackServicesOptional

public readonly fallbackServices: IResolvable | IResolvable | FallbackServicesProperty[];

Property fallbackServices: The list of fallback services.


gatewayIdOptional

public readonly gatewayId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property gatewayId: The ID of the gateway.


policiesOptional

public readonly policies: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property policies: The JSON string of route policies.


predicatesOptional

public readonly predicates: IResolvable | PredicatesProperty;

Property predicates: Matching rules for the route.


redirectJsonOptional

public readonly redirectJson: IResolvable | RedirectJSONProperty;

Property redirectJson: Configuration for redirect.


routeOrderOptional

public readonly routeOrder: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property routeOrder: The order of the route.

Smaller values indicate higher priority.


routeTypeOptional

public readonly routeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property routeType: The type of the route.

Valid value: Op (control route).


servicesOptional

public readonly services: IResolvable | IResolvable | ServicesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ServicesProperty[]

Property services: The list of backend services.

Required when DestinationType is Single, Multiple, or VersionOriented.