RewriteUrlRule

• Implements: IRewriteUrlRule

This class encapsulates and extends the ROS resource type ALIYUN::ESA::RewriteUrlRule.

Initializers

import com.aliyun.ros.cdk.esa.RewriteUrlRule;
RewriteUrlRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .queryString(java.lang.String)
//  .queryString(IResolvable)
//  .rewriteQueryStringType(java.lang.String)
//  .rewriteQueryStringType(IResolvable)
//  .rewriteUriType(java.lang.String)
//  .rewriteUriType(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .siteVersion(java.lang.Number)
//  .siteVersion(IResolvable)
//  .uri(java.lang.String)
//  .uri(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

siteId^Required

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

Property siteId: The website ID, which can be obtained by calling the ListSites operation.

queryString^Optional

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

Property queryString: The desired query string to which you want to rewrite the query string in the original request.

rewriteQueryStringType^Optional

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

Property rewriteQueryStringType: Query string rewrite type.

Value range:

• static: Static mode.
• dynamic: Dynamic mode.

rewriteUriType^Optional

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

Property rewriteUriType: URI rewrite type.

Value range:

• static: Static mode.
• dynamic: Dynamic mode.

rule^Optional

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

Property rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set. There are two usage scenarios: Match all incoming requests: value set to true Match specified request: Set the value to a custom expression, for example: (http.host eq "video.example.com").

ruleEnable^Optional

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

Property ruleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set. Value range: on: open. off: close.

ruleName^Optional

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

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.

siteVersion^Optional

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

Property siteVersion: Version number of the site configuration.

For a site with configuration version management enabled, you can use this parameter to specify the site version in which the configuration takes effect. The default version is 0.

uri^Optional

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

Property uri: The desired URI to which you want to rewrite the path in the original request.

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.esa.RewriteUrlRule;
RewriteUrlRule.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

attrConfigId^Required

public java.lang.Object getAttrConfigId();

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

Attribute ConfigId: The configuration ID.

attrConfigType^Required

public java.lang.Object getAttrConfigType();

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

Attribute ConfigType: Configuration type.

This parameter determines whether to query global configurations or feature-specific configurations. Note: This logic only takes effect if the functionName parameter is also provided.

attrQueryString^Required

public java.lang.Object getAttrQueryString();

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

Attribute QueryString: The desired query string to which you want to rewrite the query string in the original request.

attrRewriteQueryStringType^Required

public java.lang.Object getAttrRewriteQueryStringType();

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

Attribute RewriteQueryStringType: Query string rewrite type.

attrRewriteUriType^Required

public java.lang.Object getAttrRewriteUriType();

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

Attribute RewriteUriType: URI rewrite type.

attrRule^Required

public java.lang.Object getAttrRule();

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

Attribute Rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set.

attrRuleEnable^Required

public java.lang.Object getAttrRuleEnable();

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

Attribute RuleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set.

attrRuleName^Required

public java.lang.Object getAttrRuleName();

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

Attribute RuleName: Rule name.

When adding global configuration, this parameter does not need to be set.

attrSequence^Required

public java.lang.Object getAttrSequence();

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

Attribute Sequence: Rule execution order.

The smaller the value, the higher the priority of execution.

attrSiteVersion^Required

public java.lang.Object getAttrSiteVersion();

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

Attribute SiteVersion: Version number of the site configuration.

For a site with configuration version management enabled, you can use this parameter to specify the site version in which the configuration takes effect. The default version is 0.

attrUri^Required

public java.lang.Object getAttrUri();

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

Attribute Uri: The desired URI to which you want to rewrite the path in the original request.

props^Required

public RewriteUrlRuleProps getProps();

• Type: RewriteUrlRuleProps