GatewayRoute

• Implements: IGatewayRoute

This class encapsulates and extends the ROS resource type ALIYUN::MSE::GatewayRoute.

Initializers

import com.aliyun.ros.cdk.mse.GatewayRoute;
GatewayRoute.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .domainIdList(IResolvable)
    .domainIdList(java.util.List<java.lang.String)
    .domainIdList(IResolvable>)
    .gatewayUniqueId(java.lang.String)
    .gatewayUniqueId(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .destinationType(java.lang.String)
//  .destinationType(IResolvable)
//  .directResponseJson(IResolvable)
//  .directResponseJson(DirectResponseJSONProperty)
//  .domainId(java.lang.Number)
//  .domainId(IResolvable)
//  .fallback(java.lang.Boolean)
//  .fallback(IResolvable)
//  .fallbackServices(IResolvable)
//  .fallbackServices(java.util.List<IResolvable)
//  .fallbackServices(FallbackServicesProperty>)
//  .gatewayId(java.lang.Number)
//  .gatewayId(IResolvable)
//  .policies(java.lang.String)
//  .policies(IResolvable)
//  .predicates(IResolvable)
//  .predicates(PredicatesProperty)
//  .redirectJson(IResolvable)
//  .redirectJson(RedirectJSONProperty)
//  .routeOrder(java.lang.Number)
//  .routeOrder(IResolvable)
//  .routeType(java.lang.String)
//  .routeType(IResolvable)
//  .services(IResolvable)
//  .services(java.util.List<IResolvable)
//  .services(ServicesProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

domainIdList^Required

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

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

gatewayUniqueId^Required

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

Property gatewayUniqueId: The unique ID of the gateway.

name^Required

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

Property name: The name of the route.

description^Optional

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

Property description: The description of the route.

destinationType^Optional

• Type: java.lang.String OR com.aliyun.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

directResponseJson^Optional

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

Property directResponseJson: Configuration for mock response.

domainId^Optional

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

Property domainId: The ID of the domain.

fallback^Optional

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

Property fallback: Whether to enable fallback service.

fallbackServices^Optional

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

Property fallbackServices: The list of fallback services.

gatewayId^Optional

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

Property gatewayId: The ID of the gateway.

policies^Optional

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

Property policies: The JSON string of route policies.

predicates^Optional

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

Property predicates: Matching rules for the route.

redirectJson^Optional

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

Property redirectJson: Configuration for redirect.

routeOrder^Optional

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

Property routeOrder: The order of the route.

Smaller values indicate higher priority.

routeType^Optional

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

Property routeType: The type of the route.

Valid value: Op (control route).

services^Optional

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

Property services: The list of backend services.

Required when DestinationType is Single, Multiple, or VersionOriented.

Methods

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

isConstruct

import com.aliyun.ros.cdk.mse.GatewayRoute;
GatewayRoute.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attrRouteId^Required

public java.lang.Object getAttrRouteId();

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

Attribute RouteId: The ID of the route.

props^Required

public GatewayRouteProps getProps();

• Type: GatewayRouteProps