RewriteUrlRule
- Implements: IRewriteUrlRule
This class encapsulates and extends the ROS resource type ALIYUN::ESA::RewriteUrlRule.
Initializers
import { RewriteUrlRule } from '@alicloud/ros-cdk-esa'
new RewriteUrlRule(scope: Construct, id: string, props: RewriteUrlRuleProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | RewriteUrlRuleProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: RewriteUrlRuleProps
enableResourcePropertyConstraintOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { RewriteUrlRule } from '@alicloud/ros-cdk-esa'
RewriteUrlRule.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrConfigId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ConfigId: The configuration ID. |
attrConfigType | string | @alicloud/ros-cdk-core.IResolvable | Attribute ConfigType: Configuration type. |
attrQueryString | string | @alicloud/ros-cdk-core.IResolvable | Attribute QueryString: The desired query string to which you want to rewrite the query string in the original request. |
attrRewriteQueryStringType | string | @alicloud/ros-cdk-core.IResolvable | Attribute RewriteQueryStringType: Query string rewrite type. |
attrRewriteUriType | string | @alicloud/ros-cdk-core.IResolvable | Attribute RewriteUriType: URI rewrite type. |
attrRule | string | @alicloud/ros-cdk-core.IResolvable | Attribute Rule: Rule content, using conditional expressions to match user requests. |
attrRuleEnable | string | @alicloud/ros-cdk-core.IResolvable | Attribute RuleEnable: Rule switch. |
attrRuleName | string | @alicloud/ros-cdk-core.IResolvable | Attribute RuleName: Rule name. |
attrSequence | string | @alicloud/ros-cdk-core.IResolvable | Attribute Sequence: Rule execution order. |
attrSiteVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute SiteVersion: Version number of the site configuration. |
attrUri | string | @alicloud/ros-cdk-core.IResolvable | Attribute Uri: The desired URI to which you want to rewrite the path in the original request. |
props | RewriteUrlRuleProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrConfigIdRequired
public readonly attrConfigId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ConfigId: The configuration ID.
attrConfigTypeRequired
public readonly attrConfigType: string | IResolvable;
- Type: string | @alicloud/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.
attrQueryStringRequired
public readonly attrQueryString: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute QueryString: The desired query string to which you want to rewrite the query string in the original request.
attrRewriteQueryStringTypeRequired
public readonly attrRewriteQueryStringType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RewriteQueryStringType: Query string rewrite type.
attrRewriteUriTypeRequired
public readonly attrRewriteUriType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RewriteUriType: URI rewrite type.
attrRuleRequired
public readonly attrRule: string | IResolvable;
- Type: string | @alicloud/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.
attrRuleEnableRequired
public readonly attrRuleEnable: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RuleEnable: Rule switch.
When adding global configuration, this parameter does not need to be set.
attrRuleNameRequired
public readonly attrRuleName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RuleName: Rule name.
When adding global configuration, this parameter does not need to be set.
attrSequenceRequired
public readonly attrSequence: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Sequence: Rule execution order.
The smaller the value, the higher the priority of execution.
attrSiteVersionRequired
public readonly attrSiteVersion: string | IResolvable;
- Type: string | @alicloud/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.
attrUriRequired
public readonly attrUri: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Uri: The desired URI to which you want to rewrite the path in the original request.
propsRequired
public readonly props: RewriteUrlRuleProps;
- Type: RewriteUrlRuleProps