OriginRule

• Implements: IOriginRule

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

Initializers

import com.aliyun.ros.cdk.esa.OriginRule;
OriginRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .dnsRecord(java.lang.String)
//  .dnsRecord(IResolvable)
//  .follow302Enable(java.lang.String)
//  .follow302Enable(IResolvable)
//  .follow302MaxTries(java.lang.Number)
//  .follow302MaxTries(IResolvable)
//  .follow302RetainArgs(java.lang.String)
//  .follow302RetainArgs(IResolvable)
//  .follow302RetainHeader(java.lang.String)
//  .follow302RetainHeader(IResolvable)
//  .follow302TargetHost(java.lang.String)
//  .follow302TargetHost(IResolvable)
//  .originHost(java.lang.String)
//  .originHost(IResolvable)
//  .originHttpPort(java.lang.Number)
//  .originHttpPort(IResolvable)
//  .originHttpsPort(java.lang.Number)
//  .originHttpsPort(IResolvable)
//  .originMtls(java.lang.String)
//  .originMtls(IResolvable)
//  .originReadTimeout(java.lang.Number)
//  .originReadTimeout(IResolvable)
//  .originScheme(java.lang.String)
//  .originScheme(IResolvable)
//  .originSni(java.lang.String)
//  .originSni(IResolvable)
//  .originVerify(java.lang.String)
//  .originVerify(IResolvable)
//  .range(java.lang.String)
//  .range(IResolvable)
//  .rangeChunkSize(java.lang.String)
//  .rangeChunkSize(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();

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 site ID.

dnsRecord^Optional

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

Property dnsRecord: Overwrite the DNS resolution record of the origin request.

follow302Enable^Optional

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

Property follow302Enable: Return Source 302 follow switch.

Value range:

• on: ON.
• off: closed.

follow302MaxTries^Optional

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

Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].

follow302RetainArgs^Optional

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

Property follow302RetainArgs: Retain the original request parameter switch.

Value range:

• on: ON.
• off: closed.

follow302RetainHeader^Optional

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

Property follow302RetainHeader: Retain the original request header switch.

Value range:

• on: ON.
• off: closed.

follow302TargetHost^Optional

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

Property follow302TargetHost: Modify the source host after 302.

originHost^Optional

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

Property originHost: The HOST carried in the back-to-origin request.

originHttpPort^Optional

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

Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.

originHttpsPort^Optional

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

Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.

originMtls^Optional

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

Property originMtls: The mtls switch.

Value range:

• on: ON.
• off: closed.

originReadTimeout^Optional

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

Property originReadTimeout: Read timeout interval of the source station (s).

originScheme^Optional

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

Property originScheme: The protocol used by the back-to-origin request.

Value range:

• http: uses the http protocol to return to the source.
• https: uses the https protocol to return to the source.
• follow: follows the Client Protocol back to the source.

originSni^Optional

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

Property originSni: SNI carried in the back-to-origin request.

originVerify^Optional

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

Property originVerify: Source station certificate verification switch.

Value range:

• on: ON.
• off: closed.

range^Optional

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

Property range: Use the range sharding method to download the file from the source.

Value range:

• on: Open.
• off: off.
• force: force.

rangeChunkSize^Optional

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

Property rangeChunkSize: range shard size.

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.

sequence^Optional

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

siteVersion^Optional

• 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

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.OriginRule;
OriginRule.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: Back-to-source rule configuration ID.

attrConfigType^Required

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.

attrDnsRecord^Required

public java.lang.Object getAttrDnsRecord();

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

Attribute DnsRecord: Overwrite the DNS resolution record of the origin request.

attrFollow302Enable^Required

public java.lang.Object getAttrFollow302Enable();

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

Attribute Follow302Enable: Return Source 302 follow switch.

attrFollow302MaxTries^Required

public java.lang.Object getAttrFollow302MaxTries();

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

Attribute Follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].

attrFollow302RetainArgs^Required

public java.lang.Object getAttrFollow302RetainArgs();

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

Attribute Follow302RetainArgs: Retain the original request parameter switch.

attrFollow302RetainHeader^Required

public java.lang.Object getAttrFollow302RetainHeader();

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

Attribute Follow302RetainHeader: Retain the original request header switch.

attrFollow302TargetHost^Required

public java.lang.Object getAttrFollow302TargetHost();

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

Attribute Follow302TargetHost: Modify the source host after 302.

attrOriginHost^Required

public java.lang.Object getAttrOriginHost();

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

Attribute OriginHost: The HOST carried in the back-to-origin request.

attrOriginHttpPort^Required

public java.lang.Object getAttrOriginHttpPort();

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

Attribute OriginHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.

attrOriginHttpsPort^Required

public java.lang.Object getAttrOriginHttpsPort();

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

Attribute OriginHttpsPort: The port of the origin station accessed when the HTTPS protocol is used to return to the origin.

attrOriginMtls^Required

public java.lang.Object getAttrOriginMtls();

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

Attribute OriginMtls: The mtls switch.

attrOriginReadTimeout^Required

public java.lang.Object getAttrOriginReadTimeout();

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

Attribute OriginReadTimeout: Read timeout interval of the source station (s).

attrOriginScheme^Required

public java.lang.Object getAttrOriginScheme();

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

Attribute OriginScheme: The protocol used by the back-to-origin request.

attrOriginSni^Required

public java.lang.Object getAttrOriginSni();

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

Attribute OriginSni: SNI carried in the back-to-origin request.

attrOriginVerify^Required

public java.lang.Object getAttrOriginVerify();

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

Attribute OriginVerify: Source station certificate verification switch.

attrRange^Required

public java.lang.Object getAttrRange();

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

Attribute Range: Use the range sharding method to download the file from the source.

attrRangeChunkSize^Required

public java.lang.Object getAttrRangeChunkSize();

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

Attribute RangeChunkSize: range shard size.

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

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

attrSiteVersion^Required

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.

props^Required

public OriginRuleProps getProps();

• Type: OriginRuleProps