1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. esa
  5. OriginProtection
Alibaba Cloud v3.85.0 published on Tuesday, Sep 9, 2025 by Pulumi

alicloud.esa.OriginProtection

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.85.0 published on Tuesday, Sep 9, 2025 by Pulumi

    Provides a ESA Origin Protection resource.

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

    NOTE: Available since v1.256.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "tf-example";
    const _default = alicloud.esa.getSites({
        planSubscribeType: "enterpriseplan",
    });
    const defaultSite = new alicloud.esa.Site("default", {
        siteName: "chenxin0116.site",
        instanceId: _default.then(_default => _default.sites?.[0]?.instanceId),
        coverage: "overseas",
        accessType: "NS",
    });
    const defaultOriginProtection = new alicloud.esa.OriginProtection("default", {
        originConverge: "on",
        siteId: defaultSite.id,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "tf-example"
    default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
    default_site = alicloud.esa.Site("default",
        site_name="chenxin0116.site",
        instance_id=default.sites[0].instance_id,
        coverage="overseas",
        access_type="NS")
    default_origin_protection = alicloud.esa.OriginProtection("default",
        origin_converge="on",
        site_id=default_site.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/esa"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "tf-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		_default, err := esa.GetSites(ctx, &esa.GetSitesArgs{
    			PlanSubscribeType: pulumi.StringRef("enterpriseplan"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultSite, err := esa.NewSite(ctx, "default", &esa.SiteArgs{
    			SiteName:   pulumi.String("chenxin0116.site"),
    			InstanceId: pulumi.String(_default.Sites[0].InstanceId),
    			Coverage:   pulumi.String("overseas"),
    			AccessType: pulumi.String("NS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = esa.NewOriginProtection(ctx, "default", &esa.OriginProtectionArgs{
    			OriginConverge: pulumi.String("on"),
    			SiteId:         defaultSite.ID(),
    		})
    		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 config = new Config();
        var name = config.Get("name") ?? "tf-example";
        var @default = AliCloud.Esa.GetSites.Invoke(new()
        {
            PlanSubscribeType = "enterpriseplan",
        });
    
        var defaultSite = new AliCloud.Esa.Site("default", new()
        {
            SiteName = "chenxin0116.site",
            InstanceId = @default.Apply(@default => @default.Apply(getSitesResult => getSitesResult.Sites[0]?.InstanceId)),
            Coverage = "overseas",
            AccessType = "NS",
        });
    
        var defaultOriginProtection = new AliCloud.Esa.OriginProtection("default", new()
        {
            OriginConverge = "on",
            SiteId = defaultSite.Id,
        });
    
    });
    
    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.Site;
    import com.pulumi.alicloud.esa.SiteArgs;
    import com.pulumi.alicloud.esa.OriginProtection;
    import com.pulumi.alicloud.esa.OriginProtectionArgs;
    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 config = ctx.config();
            final var name = config.get("name").orElse("tf-example");
            final var default = EsaFunctions.getSites(GetSitesArgs.builder()
                .planSubscribeType("enterpriseplan")
                .build());
    
            var defaultSite = new Site("defaultSite", SiteArgs.builder()
                .siteName("chenxin0116.site")
                .instanceId(default_.sites()[0].instanceId())
                .coverage("overseas")
                .accessType("NS")
                .build());
    
            var defaultOriginProtection = new OriginProtection("defaultOriginProtection", OriginProtectionArgs.builder()
                .originConverge("on")
                .siteId(defaultSite.id())
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: tf-example
    resources:
      defaultSite:
        type: alicloud:esa:Site
        name: default
        properties:
          siteName: chenxin0116.site
          instanceId: ${default.sites[0].instanceId}
          coverage: overseas
          accessType: NS
      defaultOriginProtection:
        type: alicloud:esa:OriginProtection
        name: default
        properties:
          originConverge: on
          siteId: ${defaultSite.id}
    variables:
      default:
        fn::invoke:
          function: alicloud:esa:getSites
          arguments:
            planSubscribeType: enterpriseplan
    

    Create OriginProtection Resource

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

    Constructor syntax

    new OriginProtection(name: string, args: OriginProtectionArgs, opts?: CustomResourceOptions);
    @overload
    def OriginProtection(resource_name: str,
                         args: OriginProtectionArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def OriginProtection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         site_id: Optional[int] = None,
                         origin_converge: Optional[str] = None)
    func NewOriginProtection(ctx *Context, name string, args OriginProtectionArgs, opts ...ResourceOption) (*OriginProtection, error)
    public OriginProtection(string name, OriginProtectionArgs args, CustomResourceOptions? opts = null)
    public OriginProtection(String name, OriginProtectionArgs args)
    public OriginProtection(String name, OriginProtectionArgs args, CustomResourceOptions options)
    
    type: alicloud:esa:OriginProtection
    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 OriginProtectionArgs
    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 OriginProtectionArgs
    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 OriginProtectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OriginProtectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OriginProtectionArgs
    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 originProtectionResource = new AliCloud.Esa.OriginProtection("originProtectionResource", new()
    {
        SiteId = 0,
        OriginConverge = "string",
    });
    
    example, err := esa.NewOriginProtection(ctx, "originProtectionResource", &esa.OriginProtectionArgs{
    	SiteId:         pulumi.Int(0),
    	OriginConverge: pulumi.String("string"),
    })
    
    var originProtectionResource = new OriginProtection("originProtectionResource", OriginProtectionArgs.builder()
        .siteId(0)
        .originConverge("string")
        .build());
    
    origin_protection_resource = alicloud.esa.OriginProtection("originProtectionResource",
        site_id=0,
        origin_converge="string")
    
    const originProtectionResource = new alicloud.esa.OriginProtection("originProtectionResource", {
        siteId: 0,
        originConverge: "string",
    });
    
    type: alicloud:esa:OriginProtection
    properties:
        originConverge: string
        siteId: 0
    

    OriginProtection 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 OriginProtection resource accepts the following input properties:

    SiteId int
    Site Id
    OriginConverge string
    The IP convergence status.

    • on
    • off
    SiteId int
    Site Id
    OriginConverge string
    The IP convergence status.

    • on
    • off
    siteId Integer
    Site Id
    originConverge String
    The IP convergence status.

    • on
    • off
    siteId number
    Site Id
    originConverge string
    The IP convergence status.

    • on
    • off
    site_id int
    Site Id
    origin_converge str
    The IP convergence status.

    • on
    • off
    siteId Number
    Site Id
    originConverge String
    The IP convergence status.

    • on
    • off

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OriginProtection Resource

    Get an existing OriginProtection 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?: OriginProtectionState, opts?: CustomResourceOptions): OriginProtection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            origin_converge: Optional[str] = None,
            site_id: Optional[int] = None) -> OriginProtection
    func GetOriginProtection(ctx *Context, name string, id IDInput, state *OriginProtectionState, opts ...ResourceOption) (*OriginProtection, error)
    public static OriginProtection Get(string name, Input<string> id, OriginProtectionState? state, CustomResourceOptions? opts = null)
    public static OriginProtection get(String name, Output<String> id, OriginProtectionState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:esa:OriginProtection    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:
    OriginConverge string
    The IP convergence status.

    • on
    • off
    SiteId int
    Site Id
    OriginConverge string
    The IP convergence status.

    • on
    • off
    SiteId int
    Site Id
    originConverge String
    The IP convergence status.

    • on
    • off
    siteId Integer
    Site Id
    originConverge string
    The IP convergence status.

    • on
    • off
    siteId number
    Site Id
    origin_converge str
    The IP convergence status.

    • on
    • off
    site_id int
    Site Id
    originConverge String
    The IP convergence status.

    • on
    • off
    siteId Number
    Site Id

    Import

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

    $ pulumi import alicloud:esa/originProtection:OriginProtection example <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.85.0 published on Tuesday, Sep 9, 2025 by Pulumi