Skip to content

RouteProps

Properties for defining a Route.

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

Initializer 

import { RouteProps } from '@alicloud/ros-cdk-apig'
const routeProps: RouteProps = { ... }

Properties

Name Type Description
backend @alicloud/ros-cdk-core.IResolvable | BackendProperty Property backend: Backend service configuration for routing.
environmentInfo @alicloud/ros-cdk-core.IResolvable | EnvironmentInfoProperty Property environmentInfo: The information if the environment.
httpApiId string | @alicloud/ros-cdk-core.IResolvable Property httpApiId: The ID of the API.
match @alicloud/ros-cdk-core.IResolvable | MatchProperty Property match: The match rule of route resource.
routeName string | @alicloud/ros-cdk-core.IResolvable Property routeName: The name of the route.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of route.
domainIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property domainIds: The list of domain name IDs.
domainInfos @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DomainInfosProperty[] Property domainInfos: Domain items.

backendRequired 

public readonly backend: IResolvable | BackendProperty;

Property backend: Backend service configuration for routing.

environmentInfoRequired 

public readonly environmentInfo: IResolvable | EnvironmentInfoProperty;

Property environmentInfo: The information if the environment.

httpApiIdRequired 

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

Property httpApiId: The ID of the API.

matchRequired 

public readonly match: IResolvable | MatchProperty;

Property match: The match rule of route resource.

routeNameRequired 

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

Property routeName: The name of the route.

descriptionOptional 

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

Property description: The description of route.

domainIdsOptional 

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

Property domainIds: The list of domain name IDs.

domainInfosOptional 

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

Property domainInfos: Domain items.