Route

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

Initializers

import com.aliyun.ros.cdk.apig.Route;
Route.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .backend(IResolvable)
    .backend(BackendProperty)
    .environmentInfo(IResolvable)
    .environmentInfo(EnvironmentInfoProperty)
    .httpApiId(java.lang.String)
    .httpApiId(IResolvable)
    .match(IResolvable)
    .match(MatchProperty)
    .routeName(java.lang.String)
    .routeName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .domainIds(IResolvable)
//  .domainIds(java.util.List<java.lang.String)
//  .domainIds(IResolvable>)
//  .domainInfos(IResolvable)
//  .domainInfos(java.util.List<IResolvable)
//  .domainInfos(DomainInfosProperty>)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
backend	com.aliyun.ros.cdk.core.IResolvable OR BackendProperty	Property backend: Backend service configuration for routing.
environmentInfo	com.aliyun.ros.cdk.core.IResolvable OR EnvironmentInfoProperty	Property environmentInfo: The information if the environment.
httpApiId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property httpApiId: The ID of the API.
match	com.aliyun.ros.cdk.core.IResolvable OR MatchProperty	Property match: The match rule of route resource.
routeName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property routeName: The name of the route.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of route.
domainIds	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property domainIds: The list of domain name IDs.
domainInfos	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDomainInfosProperty>	Property domainInfos: Domain items.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

backend^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR BackendProperty

Property backend: Backend service configuration for routing.

---

environmentInfo^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR EnvironmentInfoProperty

Property environmentInfo: The information if the environment.

---

httpApiId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpApiId: The ID of the API.

---

match^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR MatchProperty

Property match: The match rule of route resource.

---

routeName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property routeName: The name of the route.

---

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of route.

---

domainIds^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property domainIds: The list of domain name IDs.

---

domainInfos^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDomainInfosProperty>

Property domainInfos: Domain items.

---

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.apig.Route;
Route.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

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

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrBackend^Required

public IResolvable getAttrBackend();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Backend: Backend services.

---

attrDescription^Required

public IResolvable getAttrDescription();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of route resource.

---

attrDomainInfos^Required

public IResolvable getAttrDomainInfos();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DomainInfos: Domain items.

---

attrEnvironmentInfo^Required

public IResolvable getAttrEnvironmentInfo();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnvironmentInfo: Environment information.

---

attrMatch^Required

public IResolvable getAttrMatch();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Match: The match rule of route resource.

---

attrRouteId^Required

public IResolvable getAttrRouteId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RouteId: The ID of route resource.

---

attrRouteName^Required

public IResolvable getAttrRouteName();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RouteName: The name of the route.

---