OriginRule

• Implements: IOriginRule

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

Initializers

import { OriginRule } from '@alicloud/ros-cdk-esa'
new OriginRule(scope: Construct, id: string, props: OriginRuleProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: OriginRuleProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrConfigId^Required

public readonly attrConfigId: string | IResolvable;

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

Attribute ConfigId: Back-to-source rule configuration ID.

attrConfigType^Required

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.

attrDnsRecord^Required

public readonly attrDnsRecord: string | IResolvable;

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

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

attrFollow302Enable^Required

public readonly attrFollow302Enable: string | IResolvable;

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

Attribute Follow302Enable: Return Source 302 follow switch.

attrFollow302MaxTries^Required

public readonly attrFollow302MaxTries: string | IResolvable;

• Type: string | @alicloud/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 readonly attrFollow302RetainArgs: string | IResolvable;

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

Attribute Follow302RetainArgs: Retain the original request parameter switch.

attrFollow302RetainHeader^Required

public readonly attrFollow302RetainHeader: string | IResolvable;

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

Attribute Follow302RetainHeader: Retain the original request header switch.

attrFollow302TargetHost^Required

public readonly attrFollow302TargetHost: string | IResolvable;

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

Attribute Follow302TargetHost: Modify the source host after 302.

attrOriginHost^Required

public readonly attrOriginHost: string | IResolvable;

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

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

attrOriginHttpPort^Required

public readonly attrOriginHttpPort: string | IResolvable;

• Type: string | @alicloud/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 readonly attrOriginHttpsPort: string | IResolvable;

• Type: string | @alicloud/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 readonly attrOriginMtls: string | IResolvable;

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

Attribute OriginMtls: The mtls switch.

attrOriginReadTimeout^Required

public readonly attrOriginReadTimeout: string | IResolvable;

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

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

attrOriginScheme^Required

public readonly attrOriginScheme: string | IResolvable;

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

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

attrOriginSni^Required

public readonly attrOriginSni: string | IResolvable;

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

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

attrOriginVerify^Required

public readonly attrOriginVerify: string | IResolvable;

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

Attribute OriginVerify: Source station certificate verification switch.

attrRange^Required

public readonly attrRange: string | IResolvable;

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

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

attrRangeChunkSize^Required

public readonly attrRangeChunkSize: string | IResolvable;

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

Attribute RangeChunkSize: range shard size.

attrRule^Required

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.

attrRuleEnable^Required

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.

attrRuleName^Required

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.

attrSequence^Required

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.

attrSiteVersion^Required

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.

props^Required

public readonly props: OriginRuleProps;

• Type: OriginRuleProps