Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. esa
  5. OriginRule
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.esa.OriginRule

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a ESA Origin Rule resource.

    For information about ESA Origin Rule and how to use it, see What is Origin Rule.

    NOTE: Available since v1.244.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const _default = alicloud.esa.getSites({
    planSubscribeType: "enterpriseplan",
});
const defaultOriginRule = new alicloud.esa.OriginRule("default", {
    originSni: "origin.example.com",
    siteId: _default.then(_default => _default.sites?.[0]?.id),
    originHost: "origin.example.com",
    dnsRecord: "tf.example.com",
    siteVersion: 0,
    ruleName: "tf",
    originHttpsPort: "443",
    originScheme: "http",
    range: "on",
    originHttpPort: "8080",
    rule: "(http.host eq \"video.example.com\")",
    ruleEnable: "on",
});

    import pulumi
import pulumi_alicloud as alicloud

default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
default_origin_rule = alicloud.esa.OriginRule("default",
    origin_sni="origin.example.com",
    site_id=default.sites[0].id,
    origin_host="origin.example.com",
    dns_record="tf.example.com",
    site_version=0,
    rule_name="tf",
    origin_https_port="443",
    origin_scheme="http",
    range="on",
    origin_http_port="8080",
    rule="(http.host eq \"video.example.com\")",
    rule_enable="on")

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/esa"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := esa.GetSites(ctx, &esa.GetSitesArgs{
			PlanSubscribeType: pulumi.StringRef("enterpriseplan"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = esa.NewOriginRule(ctx, "default", &esa.OriginRuleArgs{
			OriginSni:       pulumi.String("origin.example.com"),
			SiteId:          pulumi.Int(_default.Sites[0].Id),
			OriginHost:      pulumi.String("origin.example.com"),
			DnsRecord:       pulumi.String("tf.example.com"),
			SiteVersion:     pulumi.Int(0),
			RuleName:        pulumi.String("tf"),
			OriginHttpsPort: pulumi.String("443"),
			OriginScheme:    pulumi.String("http"),
			Range:           pulumi.String("on"),
			OriginHttpPort:  pulumi.String("8080"),
			Rule:            pulumi.String("(http.host eq \"video.example.com\")"),
			RuleEnable:      pulumi.String("on"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.Esa.GetSites.Invoke(new()
    {
        PlanSubscribeType = "enterpriseplan",
    });

    var defaultOriginRule = new AliCloud.Esa.OriginRule("default", new()
    {
        OriginSni = "origin.example.com",
        SiteId = @default.Apply(@default => @default.Apply(getSitesResult => getSitesResult.Sites[0]?.Id)),
        OriginHost = "origin.example.com",
        DnsRecord = "tf.example.com",
        SiteVersion = 0,
        RuleName = "tf",
        OriginHttpsPort = "443",
        OriginScheme = "http",
        Range = "on",
        OriginHttpPort = "8080",
        Rule = "(http.host eq \"video.example.com\")",
        RuleEnable = "on",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.esa.EsaFunctions;
import com.pulumi.alicloud.esa.inputs.GetSitesArgs;
import com.pulumi.alicloud.esa.OriginRule;
import com.pulumi.alicloud.esa.OriginRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = EsaFunctions.getSites(GetSitesArgs.builder()
            .planSubscribeType("enterpriseplan")
            .build());

        var defaultOriginRule = new OriginRule("defaultOriginRule", OriginRuleArgs.builder()
            .originSni("origin.example.com")
            .siteId(default_.sites()[0].id())
            .originHost("origin.example.com")
            .dnsRecord("tf.example.com")
            .siteVersion("0")
            .ruleName("tf")
            .originHttpsPort("443")
            .originScheme("http")
            .range("on")
            .originHttpPort("8080")
            .rule("(http.host eq \"video.example.com\")")
            .ruleEnable("on")
            .build());

    }
}

    resources:
  defaultOriginRule:
    type: alicloud:esa:OriginRule
    name: default
    properties:
      originSni: origin.example.com
      siteId: ${default.sites[0].id}
      originHost: origin.example.com
      dnsRecord: tf.example.com
      siteVersion: '0'
      ruleName: tf
      originHttpsPort: '443'
      originScheme: http
      range: on
      originHttpPort: '8080'
      rule: (http.host eq "video.example.com")
      ruleEnable: on
variables:
  default:
    fn::invoke:
      function: alicloud:esa:getSites
      arguments:
        planSubscribeType: enterpriseplan

    Create OriginRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OriginRule(name: string, args: OriginRuleArgs, opts?: CustomResourceOptions);
    @overload
def OriginRule(resource_name: str,
               args: OriginRuleArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def OriginRule(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               site_id: Optional[int] = None,
               dns_record: Optional[str] = None,
               origin_host: Optional[str] = None,
               origin_http_port: Optional[str] = None,
               origin_https_port: Optional[str] = None,
               origin_scheme: Optional[str] = None,
               origin_sni: Optional[str] = None,
               range: Optional[str] = None,
               rule: Optional[str] = None,
               rule_enable: Optional[str] = None,
               rule_name: Optional[str] = None,
               site_version: Optional[int] = None)
    func NewOriginRule(ctx *Context, name string, args OriginRuleArgs, opts ...ResourceOption) (*OriginRule, error)
    public OriginRule(string name, OriginRuleArgs args, CustomResourceOptions? opts = null)
    public OriginRule(String name, OriginRuleArgs args)
public OriginRule(String name, OriginRuleArgs args, CustomResourceOptions options)

    type: alicloud:esa:OriginRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OriginRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OriginRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OriginRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OriginRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OriginRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var originRuleResource = new AliCloud.Esa.OriginRule("originRuleResource", new()
{
    SiteId = 0,
    DnsRecord = "string",
    OriginHost = "string",
    OriginHttpPort = "string",
    OriginHttpsPort = "string",
    OriginScheme = "string",
    OriginSni = "string",
    Range = "string",
    Rule = "string",
    RuleEnable = "string",
    RuleName = "string",
    SiteVersion = 0,
});

    example, err := esa.NewOriginRule(ctx, "originRuleResource", &esa.OriginRuleArgs{
	SiteId:          pulumi.Int(0),
	DnsRecord:       pulumi.String("string"),
	OriginHost:      pulumi.String("string"),
	OriginHttpPort:  pulumi.String("string"),
	OriginHttpsPort: pulumi.String("string"),
	OriginScheme:    pulumi.String("string"),
	OriginSni:       pulumi.String("string"),
	Range:           pulumi.String("string"),
	Rule:            pulumi.String("string"),
	RuleEnable:      pulumi.String("string"),
	RuleName:        pulumi.String("string"),
	SiteVersion:     pulumi.Int(0),
})

    var originRuleResource = new OriginRule("originRuleResource", OriginRuleArgs.builder()
    .siteId(0)
    .dnsRecord("string")
    .originHost("string")
    .originHttpPort("string")
    .originHttpsPort("string")
    .originScheme("string")
    .originSni("string")
    .range("string")
    .rule("string")
    .ruleEnable("string")
    .ruleName("string")
    .siteVersion(0)
    .build());

    origin_rule_resource = alicloud.esa.OriginRule("originRuleResource",
    site_id=0,
    dns_record="string",
    origin_host="string",
    origin_http_port="string",
    origin_https_port="string",
    origin_scheme="string",
    origin_sni="string",
    range="string",
    rule="string",
    rule_enable="string",
    rule_name="string",
    site_version=0)

    const originRuleResource = new alicloud.esa.OriginRule("originRuleResource", {
    siteId: 0,
    dnsRecord: "string",
    originHost: "string",
    originHttpPort: "string",
    originHttpsPort: "string",
    originScheme: "string",
    originSni: "string",
    range: "string",
    rule: "string",
    ruleEnable: "string",
    ruleName: "string",
    siteVersion: 0,
});

    type: alicloud:esa:OriginRule
properties:
    dnsRecord: string
    originHost: string
    originHttpPort: string
    originHttpsPort: string
    originScheme: string
    originSni: string
    range: string
    rule: string
    ruleEnable: string
    ruleName: string
    siteId: 0
    siteVersion: 0

    OriginRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OriginRule resource accepts the following input properties:

    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    DnsRecord string
    Overwrite the DNS resolution record of the origin request.
    OriginHost string
    The HOST carried in the back-to-origin request.
    OriginHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    OriginHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    OriginScheme string
    The protocol used by the back-to-origin request. Value range:
    OriginSni string
    SNI carried in the back-to-origin request.
    Range string
    Use the range sharding method to download the file from the source. Value range:
    Rule string
    Rule Content.
    RuleEnable string
    Rule switch. Value range:
    RuleName string
    Rule Name.
    SiteVersion int
    Version number of the site.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    DnsRecord string
    Overwrite the DNS resolution record of the origin request.
    OriginHost string
    The HOST carried in the back-to-origin request.
    OriginHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    OriginHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    OriginScheme string
    The protocol used by the back-to-origin request. Value range:
    OriginSni string
    SNI carried in the back-to-origin request.
    Range string
    Use the range sharding method to download the file from the source. Value range:
    Rule string
    Rule Content.
    RuleEnable string
    Rule switch. Value range:
    RuleName string
    Rule Name.
    SiteVersion int
    Version number of the site.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites API.
    dnsRecord String
    Overwrite the DNS resolution record of the origin request.
    originHost String
    The HOST carried in the back-to-origin request.
    originHttpPort String
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort String
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme String
    The protocol used by the back-to-origin request. Value range:
    originSni String
    SNI carried in the back-to-origin request.
    range String
    Use the range sharding method to download the file from the source. Value range:
    rule String
    Rule Content.
    ruleEnable String
    Rule switch. Value range:
    ruleName String
    Rule Name.
    siteVersion Integer
    Version number of the site.
    siteId number
    The site ID, which can be obtained by calling the ListSites API.
    dnsRecord string
    Overwrite the DNS resolution record of the origin request.
    originHost string
    The HOST carried in the back-to-origin request.
    originHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme string
    The protocol used by the back-to-origin request. Value range:
    originSni string
    SNI carried in the back-to-origin request.
    range string
    Use the range sharding method to download the file from the source. Value range:
    rule string
    Rule Content.
    ruleEnable string
    Rule switch. Value range:
    ruleName string
    Rule Name.
    siteVersion number
    Version number of the site.
    site_id int
    The site ID, which can be obtained by calling the ListSites API.
    dns_record str
    Overwrite the DNS resolution record of the origin request.
    origin_host str
    The HOST carried in the back-to-origin request.
    origin_http_port str
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    origin_https_port str
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    origin_scheme str
    The protocol used by the back-to-origin request. Value range:
    origin_sni str
    SNI carried in the back-to-origin request.
    range str
    Use the range sharding method to download the file from the source. Value range:
    rule str
    Rule Content.
    rule_enable str
    Rule switch. Value range:
    rule_name str
    Rule Name.
    site_version int
    Version number of the site.
    siteId Number
    The site ID, which can be obtained by calling the ListSites API.
    dnsRecord String
    Overwrite the DNS resolution record of the origin request.
    originHost String
    The HOST carried in the back-to-origin request.
    originHttpPort String
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort String
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme String
    The protocol used by the back-to-origin request. Value range:
    originSni String
    SNI carried in the back-to-origin request.
    range String
    Use the range sharding method to download the file from the source. Value range:
    rule String
    Rule Content.
    ruleEnable String
    Rule switch. Value range:
    ruleName String
    Rule Name.
    siteVersion Number
    Version number of the site.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OriginRule resource produces the following output properties:

    ConfigId int
    Config Id
    Id string
    The provider-assigned unique ID for this managed resource.
    ConfigId int
    Config Id
    Id string
    The provider-assigned unique ID for this managed resource.
    configId Integer
    Config Id
    id String
    The provider-assigned unique ID for this managed resource.
    configId number
    Config Id
    id string
    The provider-assigned unique ID for this managed resource.
    config_id int
    Config Id
    id str
    The provider-assigned unique ID for this managed resource.
    configId Number
    Config Id
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OriginRule Resource

    Get an existing OriginRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OriginRuleState, opts?: CustomResourceOptions): OriginRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        dns_record: Optional[str] = None,
        origin_host: Optional[str] = None,
        origin_http_port: Optional[str] = None,
        origin_https_port: Optional[str] = None,
        origin_scheme: Optional[str] = None,
        origin_sni: Optional[str] = None,
        range: Optional[str] = None,
        rule: Optional[str] = None,
        rule_enable: Optional[str] = None,
        rule_name: Optional[str] = None,
        site_id: Optional[int] = None,
        site_version: Optional[int] = None) -> OriginRule
    func GetOriginRule(ctx *Context, name string, id IDInput, state *OriginRuleState, opts ...ResourceOption) (*OriginRule, error)
    public static OriginRule Get(string name, Input<string> id, OriginRuleState? state, CustomResourceOptions? opts = null)
    public static OriginRule get(String name, Output<String> id, OriginRuleState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:esa:OriginRule    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConfigId int
    Config Id
    DnsRecord string
    Overwrite the DNS resolution record of the origin request.
    OriginHost string
    The HOST carried in the back-to-origin request.
    OriginHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    OriginHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    OriginScheme string
    The protocol used by the back-to-origin request. Value range:
    OriginSni string
    SNI carried in the back-to-origin request.
    Range string
    Use the range sharding method to download the file from the source. Value range:
    Rule string
    Rule Content.
    RuleEnable string
    Rule switch. Value range:
    RuleName string
    Rule Name.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    SiteVersion int
    Version number of the site.
    ConfigId int
    Config Id
    DnsRecord string
    Overwrite the DNS resolution record of the origin request.
    OriginHost string
    The HOST carried in the back-to-origin request.
    OriginHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    OriginHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    OriginScheme string
    The protocol used by the back-to-origin request. Value range:
    OriginSni string
    SNI carried in the back-to-origin request.
    Range string
    Use the range sharding method to download the file from the source. Value range:
    Rule string
    Rule Content.
    RuleEnable string
    Rule switch. Value range:
    RuleName string
    Rule Name.
    SiteId int
    The site ID, which can be obtained by calling the ListSites API.
    SiteVersion int
    Version number of the site.
    configId Integer
    Config Id
    dnsRecord String
    Overwrite the DNS resolution record of the origin request.
    originHost String
    The HOST carried in the back-to-origin request.
    originHttpPort String
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort String
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme String
    The protocol used by the back-to-origin request. Value range:
    originSni String
    SNI carried in the back-to-origin request.
    range String
    Use the range sharding method to download the file from the source. Value range:
    rule String
    Rule Content.
    ruleEnable String
    Rule switch. Value range:
    ruleName String
    Rule Name.
    siteId Integer
    The site ID, which can be obtained by calling the ListSites API.
    siteVersion Integer
    Version number of the site.
    configId number
    Config Id
    dnsRecord string
    Overwrite the DNS resolution record of the origin request.
    originHost string
    The HOST carried in the back-to-origin request.
    originHttpPort string
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort string
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme string
    The protocol used by the back-to-origin request. Value range:
    originSni string
    SNI carried in the back-to-origin request.
    range string
    Use the range sharding method to download the file from the source. Value range:
    rule string
    Rule Content.
    ruleEnable string
    Rule switch. Value range:
    ruleName string
    Rule Name.
    siteId number
    The site ID, which can be obtained by calling the ListSites API.
    siteVersion number
    Version number of the site.
    config_id int
    Config Id
    dns_record str
    Overwrite the DNS resolution record of the origin request.
    origin_host str
    The HOST carried in the back-to-origin request.
    origin_http_port str
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    origin_https_port str
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    origin_scheme str
    The protocol used by the back-to-origin request. Value range:
    origin_sni str
    SNI carried in the back-to-origin request.
    range str
    Use the range sharding method to download the file from the source. Value range:
    rule str
    Rule Content.
    rule_enable str
    Rule switch. Value range:
    rule_name str
    Rule Name.
    site_id int
    The site ID, which can be obtained by calling the ListSites API.
    site_version int
    Version number of the site.
    configId Number
    Config Id
    dnsRecord String
    Overwrite the DNS resolution record of the origin request.
    originHost String
    The HOST carried in the back-to-origin request.
    originHttpPort String
    The port of the origin station accessed when the HTTP protocol is used to return to the origin.
    originHttpsPort String
    The port of the origin station accessed when the HTTPS protocol is used to return to the origin.
    originScheme String
    The protocol used by the back-to-origin request. Value range:
    originSni String
    SNI carried in the back-to-origin request.
    range String
    Use the range sharding method to download the file from the source. Value range:
    rule String
    Rule Content.
    ruleEnable String
    Rule switch. Value range:
    ruleName String
    Rule Name.
    siteId Number
    The site ID, which can be obtained by calling the ListSites API.
    siteVersion Number
    Version number of the site.

    Import

    ESA Origin Rule can be imported using the id, e.g.

    $ pulumi import alicloud:esa/originRule:OriginRule example <site_id>:<config_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-alicloud