Route

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Route.

Initializers

import { Route } from '@alicloud/ros-cdk-apig'
new Route(scope: Construct, id: string, props: RouteProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	RouteProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: RouteProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import { Route } from '@alicloud/ros-cdk-apig'
Route.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrBackend	@alicloud/ros-cdk-core.IResolvable	Attribute Backend: Backend services.
attrDescription	@alicloud/ros-cdk-core.IResolvable	Attribute Description: The description of route resource.
attrDomainInfos	@alicloud/ros-cdk-core.IResolvable	Attribute DomainInfos: Domain items.
attrEnvironmentInfo	@alicloud/ros-cdk-core.IResolvable	Attribute EnvironmentInfo: Environment information.
attrMatch	@alicloud/ros-cdk-core.IResolvable	Attribute Match: The match rule of route resource.
attrRouteId	@alicloud/ros-cdk-core.IResolvable	Attribute RouteId: The ID of route resource.
attrRouteName	@alicloud/ros-cdk-core.IResolvable	Attribute RouteName: The name of the route.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrBackend^Required

public readonly attrBackend: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Backend: Backend services.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of route resource.

---

attrDomainInfos^Required

public readonly attrDomainInfos: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute DomainInfos: Domain items.

---

attrEnvironmentInfo^Required

public readonly attrEnvironmentInfo: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnvironmentInfo: Environment information.

---

attrMatch^Required

public readonly attrMatch: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Match: The match rule of route resource.

---

attrRouteId^Required

public readonly attrRouteId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute RouteId: The ID of route resource.

---

attrRouteName^Required

public readonly attrRouteName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute RouteName: The name of the route.

---