Skip to content

OriginRule

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

Initializers 

import ros_cdk_esa
ros_cdk_esa.OriginRule(
  scope: Construct,
  id: str,
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  dns_record: typing.Union[str, IResolvable] = None,
  follow302_enable: typing.Union[str, IResolvable] = None,
  follow302_max_tries: typing.Union[typing.Union[int, float], IResolvable] = None,
  follow302_retain_args: typing.Union[str, IResolvable] = None,
  follow302_retain_header: typing.Union[str, IResolvable] = None,
  follow302_target_host: typing.Union[str, IResolvable] = None,
  origin_host: typing.Union[str, IResolvable] = None,
  origin_http_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  origin_https_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  origin_mtls: typing.Union[str, IResolvable] = None,
  origin_read_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  origin_scheme: typing.Union[str, IResolvable] = None,
  origin_sni: typing.Union[str, IResolvable] = None,
  origin_verify: typing.Union[str, IResolvable] = None,
  range: typing.Union[str, IResolvable] = None,
  range_chunk_size: typing.Union[str, IResolvable] = None,
  rule: typing.Union[str, IResolvable] = None,
  rule_enable: typing.Union[str, IResolvable] = None,
  rule_name: typing.Union[str, IResolvable] = None,
  sequence: typing.Union[typing.Union[int, float], IResolvable] = None,
  site_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
site_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property siteId: The site ID.
dns_record typing.Union[str, ros_cdk_core.IResolvable] Property dnsRecord: Overwrite the DNS resolution record of the origin request.
follow302_enable typing.Union[str, ros_cdk_core.IResolvable] Property follow302Enable: Return Source 302 follow switch.
follow302_max_tries typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].
follow302_retain_args typing.Union[str, ros_cdk_core.IResolvable] Property follow302RetainArgs: Retain the original request parameter switch.
follow302_retain_header typing.Union[str, ros_cdk_core.IResolvable] Property follow302RetainHeader: Retain the original request header switch.
follow302_target_host typing.Union[str, ros_cdk_core.IResolvable] Property follow302TargetHost: Modify the source host after 302.
origin_host typing.Union[str, ros_cdk_core.IResolvable] Property originHost: The HOST carried in the back-to-origin request.
origin_http_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.
origin_https_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.
origin_mtls typing.Union[str, ros_cdk_core.IResolvable] Property originMtls: The mtls switch.
origin_read_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property originReadTimeout: Read timeout interval of the source station (s).
origin_scheme typing.Union[str, ros_cdk_core.IResolvable] Property originScheme: The protocol used by the back-to-origin request.
origin_sni typing.Union[str, ros_cdk_core.IResolvable] Property originSni: SNI carried in the back-to-origin request.
origin_verify typing.Union[str, ros_cdk_core.IResolvable] Property originVerify: Source station certificate verification switch.
range typing.Union[str, ros_cdk_core.IResolvable] Property range: Use the range sharding method to download the file from the source.
range_chunk_size typing.Union[str, ros_cdk_core.IResolvable] Property rangeChunkSize: range shard size.
rule typing.Union[str, ros_cdk_core.IResolvable] Property rule: Rule content, using conditional expressions to match user requests.
rule_enable typing.Union[str, ros_cdk_core.IResolvable] Property ruleEnable: Rule switch.
rule_name typing.Union[str, ros_cdk_core.IResolvable] Property ruleName: Rule name.
sequence typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property sequence: Order of rule execution.
site_version typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property siteVersion: The version number of the site configuration.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

site_idRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property siteId: The site ID.

dns_recordOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

follow302_enableOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property follow302Enable: Return Source 302 follow switch.

Value range:

  • on: ON.
  • off: closed.

follow302_max_triesOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

follow302_retain_argsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property follow302RetainArgs: Retain the original request parameter switch.

Value range:

  • on: ON.
  • off: closed.

follow302_retain_headerOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property follow302RetainHeader: Retain the original request header switch.

Value range:

  • on: ON.
  • off: closed.

follow302_target_hostOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property follow302TargetHost: Modify the source host after 302.

origin_hostOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

origin_http_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

origin_https_portOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

origin_mtlsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property originMtls: The mtls switch.

Value range:

  • on: ON.
  • off: closed.

origin_read_timeoutOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

origin_schemeOptional

  • Type: typing.Union[str, 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.

origin_sniOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

origin_verifyOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property originVerify: Source station certificate verification switch.

Value range:

  • on: ON.
  • off: closed.

rangeOptional

  • Type: typing.Union[str, 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.

range_chunk_sizeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property rangeChunkSize: range shard size.

ruleOptional

  • Type: typing.Union[str, 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").

rule_enableOptional

  • Type: typing.Union[str, 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.

rule_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.

sequenceOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property sequence: Order of rule execution.

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

site_versionOptional

  • Type: typing.Union[typing.Union[int, float], 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition 

def fetch_condition() -> RosCondition

fetch_dependency 

def fetch_dependency() -> typing.List[str]

fetch_resource_desc 

def fetch_resource_desc() -> str

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_esa
ros_cdk_esa.OriginRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_config_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ConfigId: Back-to-source rule configuration ID.
attr_config_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ConfigType: The configuration type.
attr_dns_record typing.Union[str, ros_cdk_core.IResolvable] Attribute DnsRecord: Overwrite the DNS resolution record of the origin request.
attr_follow302_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute Follow302Enable: Return Source 302 follow switch.
attr_follow302_max_tries typing.Union[str, ros_cdk_core.IResolvable] Attribute Follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].
attr_follow302_retain_args typing.Union[str, ros_cdk_core.IResolvable] Attribute Follow302RetainArgs: Retain the original request parameter switch.
attr_follow302_retain_header typing.Union[str, ros_cdk_core.IResolvable] Attribute Follow302RetainHeader: Retain the original request header switch.
attr_follow302_target_host typing.Union[str, ros_cdk_core.IResolvable] Attribute Follow302TargetHost: Modify the source host after 302.
attr_origin_host typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginHost: The HOST carried in the back-to-origin request.
attr_origin_http_port typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.
attr_origin_https_port typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginHttpsPort: The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
attr_origin_mtls typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginMtls: The mtls switch.
attr_origin_read_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginReadTimeout: Read timeout interval of the source station (s).
attr_origin_scheme typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginScheme: The protocol used by the back-to-origin request.
attr_origin_sni typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginSni: SNI carried in the back-to-origin request.
attr_origin_verify typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginVerify: Source station certificate verification switch.
attr_range typing.Union[str, ros_cdk_core.IResolvable] Attribute Range: Use the range sharding method to download the file from the source.
attr_range_chunk_size typing.Union[str, ros_cdk_core.IResolvable] Attribute RangeChunkSize: range shard size.
attr_rule typing.Union[str, ros_cdk_core.IResolvable] Attribute Rule: Rule content, using conditional expressions to match user requests.
attr_rule_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleEnable: Rule switch.
attr_rule_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleName: Rule name.
attr_sequence typing.Union[str, ros_cdk_core.IResolvable] Attribute Sequence: Order of rule execution.
attr_site_version typing.Union[str, ros_cdk_core.IResolvable] Attribute SiteVersion: The version number of the site configuration.
props OriginRuleProps No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

envRequired 

env: IResourceEnvironment
  • Type: 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 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_config_idRequired 

attr_config_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_config_typeRequired 

attr_config_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ConfigType: The configuration type.

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

attr_dns_recordRequired 

attr_dns_record: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_follow302_enableRequired 

attr_follow302_enable: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Follow302Enable: Return Source 302 follow switch.

attr_follow302_max_triesRequired 

attr_follow302_max_tries: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_follow302_retain_argsRequired 

attr_follow302_retain_args: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Follow302RetainArgs: Retain the original request parameter switch.

attr_follow302_retain_headerRequired 

attr_follow302_retain_header: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Follow302RetainHeader: Retain the original request header switch.

attr_follow302_target_hostRequired 

attr_follow302_target_host: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Follow302TargetHost: Modify the source host after 302.

attr_origin_hostRequired 

attr_origin_host: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_http_portRequired 

attr_origin_http_port: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_https_portRequired 

attr_origin_https_port: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_mtlsRequired 

attr_origin_mtls: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute OriginMtls: The mtls switch.

attr_origin_read_timeoutRequired 

attr_origin_read_timeout: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_schemeRequired 

attr_origin_scheme: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_sniRequired 

attr_origin_sni: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_origin_verifyRequired 

attr_origin_verify: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute OriginVerify: Source station certificate verification switch.

attr_rangeRequired 

attr_range: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_range_chunk_sizeRequired 

attr_range_chunk_size: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RangeChunkSize: range shard size.

attr_ruleRequired 

attr_rule: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

attr_rule_enableRequired 

attr_rule_enable: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set.

attr_rule_nameRequired 

attr_rule_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleName: Rule name.

When adding global configuration, this parameter does not need to be set.

attr_sequenceRequired 

attr_sequence: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Sequence: Order of rule execution.

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

attr_site_versionRequired 

attr_site_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

props: OriginRuleProps