Skip to content

HttpIncomingResponseHeaderModificationRule

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

Initializers

import com.aliyun.ros.cdk.esa.HttpIncomingResponseHeaderModificationRule;
HttpIncomingResponseHeaderModificationRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .responseHeaderModification(IResolvable)
    .responseHeaderModification(java.util.List<IResolvable)
    .responseHeaderModification(ResponseHeaderModificationProperty>)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .sequence(java.lang.Number)
//  .sequence(IResolvable)
//  .siteVersion(java.lang.Number)
//  .siteVersion(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.
responseHeaderModification com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResponseHeaderModificationProperty> Property responseHeaderModification: Modify response headers, supporting add, delete, and modify operations.
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: The site ID.
rule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rule: Rule content, using conditional expressions to match user requests.
ruleEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleEnable: Rule switch.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: Rule name.
sequence java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sequence: Order of rule execution.
siteVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteVersion: The version number of the site configuration.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

responseHeaderModificationRequired

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

Property responseHeaderModification: Modify response headers, supporting add, delete, and modify operations.


siteIdRequired

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

Property siteId: The site ID.


ruleOptional

  • 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").

ruleEnableOptional

  • 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.

ruleNameOptional

  • 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.


sequenceOptional

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

Property sequence: Order of rule execution.

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


siteVersionOptional

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

Property 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.


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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • 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)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.esa.HttpIncomingResponseHeaderModificationRule;
HttpIncomingResponseHeaderModificationRule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrConfigId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigId: Config Id.
attrConfigType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ConfigType: The configuration type.
attrResponseHeaderModification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResponseHeaderModification: Modify response headers, supporting add, delete, and modify operations.
attrRule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Rule: Rule content, using conditional expressions to match user requests.
attrRuleEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RuleEnable: Rule switch.
attrRuleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RuleName: Rule name.
attrSequence java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Sequence: Order of rule execution.
attrSiteVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SiteVersion: The version number of the site configuration.
props HttpIncomingResponseHeaderModificationRuleProps 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

attrConfigIdRequired

public java.lang.Object getAttrConfigId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigId: Config Id.


attrConfigTypeRequired

public java.lang.Object getAttrConfigType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConfigType: The configuration type.


attrResponseHeaderModificationRequired

public java.lang.Object getAttrResponseHeaderModification();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResponseHeaderModification: Modify response headers, supporting add, delete, and modify operations.


attrRuleRequired

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.


attrRuleEnableRequired

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.


attrRuleNameRequired

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.


attrSequenceRequired

public java.lang.Object getAttrSequence();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Sequence: Order of rule execution.

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


attrSiteVersionRequired

public java.lang.Object getAttrSiteVersion();
  • Type: java.lang.String OR com.aliyun.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 HttpIncomingResponseHeaderModificationRuleProps getProps();