RoutineRoute
- Implements: IRoutineRoute
This class encapsulates and extends the ROS resource type ALIYUN::ESA::RoutineRoute.
Initializers
import com.aliyun.ros.cdk.esa.RoutineRoute;
RoutineRoute.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.routineName(java.lang.String)
.routineName(IResolvable)
.siteId(java.lang.Number)
.siteId(IResolvable)
// .bypass(java.lang.String)
// .bypass(IResolvable)
// .fallback(java.lang.String)
// .fallback(IResolvable)
// .routeEnable(java.lang.String)
// .routeEnable(IResolvable)
// .routeName(java.lang.String)
// .routeName(IResolvable)
// .rule(java.lang.String)
// .rule(IResolvable)
// .sequence(java.lang.Number)
// .sequence(IResolvable)
.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. |
routineName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property routineName: The edge function Routine name. |
siteId | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property siteId: The website ID. |
bypass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property bypass: Bypass mode. |
fallback | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property fallback: The exception origin fetch switch. |
routeEnable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property routeEnable: Routing switch. |
routeName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property routeName: The name of the route. |
rule | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property rule: The content of the rule. |
sequence | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property sequence: Rule execution order. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
routineNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property routineName: The edge function Routine name.
siteIdRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property siteId: The website ID.
bypassOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property bypass: Bypass mode.
Value range:
- on: Open
- off: off.
fallbackOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property fallback: The exception origin fetch switch.
After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values: on off
routeEnableOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property routeEnable: Routing switch.
Value range:
- on: Open
- off: off.
routeNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property routeName: The name of the route.
ruleOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property rule: The content of the rule.
sequenceOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property sequence: Rule execution order.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.esa.RoutineRoute;
RoutineRoute.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrBypass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Bypass: Bypass mode. |
attrConfigId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConfigId: The configuration ID. |
attrConfigType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConfigType: The configuration type. |
attrFallback | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Fallback: An exception to the origin server switch will be enabled. |
attrMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Mode: Configuration mode. |
attrRouteEnable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RouteEnable: Routing switch. |
attrRouteName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RouteName: The route name. |
attrRoutineName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RoutineName: The edge function Routine name. |
attrRule | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Rule: The content of the rule. |
attrSequence | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Sequence: Rule execution order. |
attrSiteVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SiteVersion: Version number of the site. |
props | RoutineRouteProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrBypassRequired
public java.lang.Object getAttrBypass();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Bypass: Bypass mode.
attrConfigIdRequired
public java.lang.Object getAttrConfigId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConfigId: The configuration ID.
attrConfigTypeRequired
public java.lang.Object getAttrConfigType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConfigType: The configuration type.
You can use this parameter to check the global configuration or rule configuration.
attrFallbackRequired
public java.lang.Object getAttrFallback();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Fallback: An exception to the origin server switch will be enabled.
If an exception occurs in the function, such as CPU usage exceeding limits, a request will be made to return to the origin server.
attrModeRequired
public java.lang.Object getAttrMode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Mode: Configuration mode.
attrRouteEnableRequired
public java.lang.Object getAttrRouteEnable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RouteEnable: Routing switch.
attrRouteNameRequired
public java.lang.Object getAttrRouteName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RouteName: The route name.
attrRoutineNameRequired
public java.lang.Object getAttrRoutineName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RoutineName: The edge function Routine name.
attrRuleRequired
public java.lang.Object getAttrRule();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Rule: The content of the rule.
attrSequenceRequired
public java.lang.Object getAttrSequence();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Sequence: Rule execution order.
attrSiteVersionRequired
public java.lang.Object getAttrSiteVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SiteVersion: Version number of the site.
propsRequired
public RoutineRouteProps getProps();
- Type: RoutineRouteProps