Skip to content

HttpIncomingRequestHeaderModificationRule

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

Initializers

import { HttpIncomingRequestHeaderModificationRule } from '@alicloud/ros-cdk-esa'
new HttpIncomingRequestHeaderModificationRule(scope: Construct, id: string, props: HttpIncomingRequestHeaderModificationRuleProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props HttpIncomingRequestHeaderModificationRuleProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { HttpIncomingRequestHeaderModificationRule } from '@alicloud/ros-cdk-esa'
HttpIncomingRequestHeaderModificationRule.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • 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: Config Id.
attrConfigType string | @alicloud/ros-cdk-core.IResolvable Attribute ConfigType: The configuration type.
attrRequestHeaderModification string | @alicloud/ros-cdk-core.IResolvable Attribute RequestHeaderModification: The configurations of modifying request headers.
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: Order of rule execution.
attrSiteVersion string | @alicloud/ros-cdk-core.IResolvable Attribute SiteVersion: The version number of the site configuration.
props HttpIncomingRequestHeaderModificationRuleProps 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: Config Id.


attrConfigTypeRequired

public readonly attrConfigType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConfigType: The configuration type.

You can use this parameter to check the global configuration or rule configuration.


attrRequestHeaderModificationRequired

public readonly attrRequestHeaderModification: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute RequestHeaderModification: The configurations of modifying request headers.

You can add, delete, or modify a request header.


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: Order of rule execution.

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


attrSiteVersionRequired

public readonly attrSiteVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SiteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.


propsRequired

public readonly props: HttpIncomingRequestHeaderModificationRuleProps;