pulumi-alicloud 3.73.0a1736850863__py3-none-any.whl → 3.74.0__py3-none-any.whl

pulumi_alicloud/esa/http_request_header_modification_rule.py

@@ -0,0 +1,531 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+from ._inputs import *
+
+__all__ = ['HttpRequestHeaderModificationRuleArgs', 'HttpRequestHeaderModificationRule']
+
+@pulumi.input_type
+class HttpRequestHeaderModificationRuleArgs:
+    def __init__(__self__, *,
+                 request_header_modifications: pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]],
+                 site_id: pulumi.Input[int],
+                 rule: Optional[pulumi.Input[str]] = None,
+                 rule_enable: Optional[pulumi.Input[str]] = None,
+                 rule_name: Optional[pulumi.Input[str]] = None,
+                 site_version: Optional[pulumi.Input[int]] = None):
+        """
+        The set of arguments for constructing a HttpRequestHeaderModificationRule resource.
+        :param pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]] request_header_modifications: The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        :param pulumi.Input[int] site_id: The site ID, which can be obtained by calling the ListSites API.
+        :param pulumi.Input[str] rule: The rule content.
+        :param pulumi.Input[str] rule_enable: Rule switch. Value range:
+               on: Open.
+               off: off.
+        :param pulumi.Input[str] rule_name: Rule Name.
+        :param pulumi.Input[int] site_version: The version number of the website configurations.
+        """
+        pulumi.set(__self__, "request_header_modifications", request_header_modifications)
+        pulumi.set(__self__, "site_id", site_id)
+        if rule is not None:
+            pulumi.set(__self__, "rule", rule)
+        if rule_enable is not None:
+            pulumi.set(__self__, "rule_enable", rule_enable)
+        if rule_name is not None:
+            pulumi.set(__self__, "rule_name", rule_name)
+        if site_version is not None:
+            pulumi.set(__self__, "site_version", site_version)
+
+    @property
+    @pulumi.getter(name="requestHeaderModifications")
+    def request_header_modifications(self) -> pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]]:
+        """
+        The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        """
+        return pulumi.get(self, "request_header_modifications")
+
+    @request_header_modifications.setter
+    def request_header_modifications(self, value: pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]]):
+        pulumi.set(self, "request_header_modifications", value)
+
+    @property
+    @pulumi.getter(name="siteId")
+    def site_id(self) -> pulumi.Input[int]:
+        """
+        The site ID, which can be obtained by calling the ListSites API.
+        """
+        return pulumi.get(self, "site_id")
+
+    @site_id.setter
+    def site_id(self, value: pulumi.Input[int]):
+        pulumi.set(self, "site_id", value)
+
+    @property
+    @pulumi.getter
+    def rule(self) -> Optional[pulumi.Input[str]]:
+        """
+        The rule content.
+        """
+        return pulumi.get(self, "rule")
+
+    @rule.setter
+    def rule(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule", value)
+
+    @property
+    @pulumi.getter(name="ruleEnable")
+    def rule_enable(self) -> Optional[pulumi.Input[str]]:
+        """
+        Rule switch. Value range:
+        on: Open.
+        off: off.
+        """
+        return pulumi.get(self, "rule_enable")
+
+    @rule_enable.setter
+    def rule_enable(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule_enable", value)
+
+    @property
+    @pulumi.getter(name="ruleName")
+    def rule_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        Rule Name.
+        """
+        return pulumi.get(self, "rule_name")
+
+    @rule_name.setter
+    def rule_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule_name", value)
+
+    @property
+    @pulumi.getter(name="siteVersion")
+    def site_version(self) -> Optional[pulumi.Input[int]]:
+        """
+        The version number of the website configurations.
+        """
+        return pulumi.get(self, "site_version")
+
+    @site_version.setter
+    def site_version(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "site_version", value)
+
+
+@pulumi.input_type
+class _HttpRequestHeaderModificationRuleState:
+    def __init__(__self__, *,
+                 config_id: Optional[pulumi.Input[int]] = None,
+                 request_header_modifications: Optional[pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]]] = None,
+                 rule: Optional[pulumi.Input[str]] = None,
+                 rule_enable: Optional[pulumi.Input[str]] = None,
+                 rule_name: Optional[pulumi.Input[str]] = None,
+                 site_id: Optional[pulumi.Input[int]] = None,
+                 site_version: Optional[pulumi.Input[int]] = None):
+        """
+        Input properties used for looking up and filtering HttpRequestHeaderModificationRule resources.
+        :param pulumi.Input[int] config_id: Config Id
+        :param pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]] request_header_modifications: The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        :param pulumi.Input[str] rule: The rule content.
+        :param pulumi.Input[str] rule_enable: Rule switch. Value range:
+               on: Open.
+               off: off.
+        :param pulumi.Input[str] rule_name: Rule Name.
+        :param pulumi.Input[int] site_id: The site ID, which can be obtained by calling the ListSites API.
+        :param pulumi.Input[int] site_version: The version number of the website configurations.
+        """
+        if config_id is not None:
+            pulumi.set(__self__, "config_id", config_id)
+        if request_header_modifications is not None:
+            pulumi.set(__self__, "request_header_modifications", request_header_modifications)
+        if rule is not None:
+            pulumi.set(__self__, "rule", rule)
+        if rule_enable is not None:
+            pulumi.set(__self__, "rule_enable", rule_enable)
+        if rule_name is not None:
+            pulumi.set(__self__, "rule_name", rule_name)
+        if site_id is not None:
+            pulumi.set(__self__, "site_id", site_id)
+        if site_version is not None:
+            pulumi.set(__self__, "site_version", site_version)
+
+    @property
+    @pulumi.getter(name="configId")
+    def config_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        Config Id
+        """
+        return pulumi.get(self, "config_id")
+
+    @config_id.setter
+    def config_id(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "config_id", value)
+
+    @property
+    @pulumi.getter(name="requestHeaderModifications")
+    def request_header_modifications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]]]:
+        """
+        The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        """
+        return pulumi.get(self, "request_header_modifications")
+
+    @request_header_modifications.setter
+    def request_header_modifications(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs']]]]):
+        pulumi.set(self, "request_header_modifications", value)
+
+    @property
+    @pulumi.getter
+    def rule(self) -> Optional[pulumi.Input[str]]:
+        """
+        The rule content.
+        """
+        return pulumi.get(self, "rule")
+
+    @rule.setter
+    def rule(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule", value)
+
+    @property
+    @pulumi.getter(name="ruleEnable")
+    def rule_enable(self) -> Optional[pulumi.Input[str]]:
+        """
+        Rule switch. Value range:
+        on: Open.
+        off: off.
+        """
+        return pulumi.get(self, "rule_enable")
+
+    @rule_enable.setter
+    def rule_enable(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule_enable", value)
+
+    @property
+    @pulumi.getter(name="ruleName")
+    def rule_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        Rule Name.
+        """
+        return pulumi.get(self, "rule_name")
+
+    @rule_name.setter
+    def rule_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "rule_name", value)
+
+    @property
+    @pulumi.getter(name="siteId")
+    def site_id(self) -> Optional[pulumi.Input[int]]:
+        """
+        The site ID, which can be obtained by calling the ListSites API.
+        """
+        return pulumi.get(self, "site_id")
+
+    @site_id.setter
+    def site_id(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "site_id", value)
+
+    @property
+    @pulumi.getter(name="siteVersion")
+    def site_version(self) -> Optional[pulumi.Input[int]]:
+        """
+        The version number of the website configurations.
+        """
+        return pulumi.get(self, "site_version")
+
+    @site_version.setter
+    def site_version(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "site_version", value)
+
+
+class HttpRequestHeaderModificationRule(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 request_header_modifications: Optional[pulumi.Input[Sequence[pulumi.Input[Union['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs', 'HttpRequestHeaderModificationRuleRequestHeaderModificationArgsDict']]]]] = None,
+                 rule: Optional[pulumi.Input[str]] = None,
+                 rule_enable: Optional[pulumi.Input[str]] = None,
+                 rule_name: Optional[pulumi.Input[str]] = None,
+                 site_id: Optional[pulumi.Input[int]] = None,
+                 site_version: Optional[pulumi.Input[int]] = None,
+                 __props__=None):
+        """
+        Provides a ESA Http Request Header Modification Rule resource.
+
+        For information about ESA Http Request Header Modification Rule and how to use it, see [What is Http Request Header Modification Rule](https://www.alibabacloud.com/help/en/).
+
+        > **NOTE:** Available since v1.242.0.
+
+        ## Example Usage
+
+        Basic Usage
+
+        ```python
+        import pulumi
+        import pulumi_alicloud as alicloud
+
+        config = pulumi.Config()
+        name = config.get("name")
+        if name is None:
+            name = "terraform-example"
+        instance = alicloud.esa.RatePlanInstance("instance",
+            type="NS",
+            auto_renew=False,
+            period=1,
+            payment_type="Subscription",
+            coverage="overseas",
+            auto_pay=True,
+            plan_name="high")
+        site = alicloud.esa.Site("site",
+            site_name="gositecdn.cn",
+            instance_id=instance.id,
+            coverage="overseas",
+            access_type="NS")
+        default = alicloud.esa.HttpRequestHeaderModificationRule("default",
+            rule_name="example_modify",
+            request_header_modifications=[{
+                "value": "modify1",
+                "operation": "modify",
+                "name": "example_modify1",
+            }],
+            site_id=site.id,
+            rule_enable="off",
+            rule="(http.request.uri eq \\"/content?page=1234\\")",
+            site_version=0)
+        ```
+
+        ## Import
+
+        ESA Http Request Header Modification Rule can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:esa/httpRequestHeaderModificationRule:HttpRequestHeaderModificationRule example <site_id>:<config_id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[Sequence[pulumi.Input[Union['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs', 'HttpRequestHeaderModificationRuleRequestHeaderModificationArgsDict']]]] request_header_modifications: The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        :param pulumi.Input[str] rule: The rule content.
+        :param pulumi.Input[str] rule_enable: Rule switch. Value range:
+               on: Open.
+               off: off.
+        :param pulumi.Input[str] rule_name: Rule Name.
+        :param pulumi.Input[int] site_id: The site ID, which can be obtained by calling the ListSites API.
+        :param pulumi.Input[int] site_version: The version number of the website configurations.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: HttpRequestHeaderModificationRuleArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a ESA Http Request Header Modification Rule resource.
+
+        For information about ESA Http Request Header Modification Rule and how to use it, see [What is Http Request Header Modification Rule](https://www.alibabacloud.com/help/en/).
+
+        > **NOTE:** Available since v1.242.0.
+
+        ## Example Usage
+
+        Basic Usage
+
+        ```python
+        import pulumi
+        import pulumi_alicloud as alicloud
+
+        config = pulumi.Config()
+        name = config.get("name")
+        if name is None:
+            name = "terraform-example"
+        instance = alicloud.esa.RatePlanInstance("instance",
+            type="NS",
+            auto_renew=False,
+            period=1,
+            payment_type="Subscription",
+            coverage="overseas",
+            auto_pay=True,
+            plan_name="high")
+        site = alicloud.esa.Site("site",
+            site_name="gositecdn.cn",
+            instance_id=instance.id,
+            coverage="overseas",
+            access_type="NS")
+        default = alicloud.esa.HttpRequestHeaderModificationRule("default",
+            rule_name="example_modify",
+            request_header_modifications=[{
+                "value": "modify1",
+                "operation": "modify",
+                "name": "example_modify1",
+            }],
+            site_id=site.id,
+            rule_enable="off",
+            rule="(http.request.uri eq \\"/content?page=1234\\")",
+            site_version=0)
+        ```
+
+        ## Import
+
+        ESA Http Request Header Modification Rule can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:esa/httpRequestHeaderModificationRule:HttpRequestHeaderModificationRule example <site_id>:<config_id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param HttpRequestHeaderModificationRuleArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(HttpRequestHeaderModificationRuleArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 request_header_modifications: Optional[pulumi.Input[Sequence[pulumi.Input[Union['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs', 'HttpRequestHeaderModificationRuleRequestHeaderModificationArgsDict']]]]] = None,
+                 rule: Optional[pulumi.Input[str]] = None,
+                 rule_enable: Optional[pulumi.Input[str]] = None,
+                 rule_name: Optional[pulumi.Input[str]] = None,
+                 site_id: Optional[pulumi.Input[int]] = None,
+                 site_version: Optional[pulumi.Input[int]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = HttpRequestHeaderModificationRuleArgs.__new__(HttpRequestHeaderModificationRuleArgs)
+
+            if request_header_modifications is None and not opts.urn:
+                raise TypeError("Missing required property 'request_header_modifications'")
+            __props__.__dict__["request_header_modifications"] = request_header_modifications
+            __props__.__dict__["rule"] = rule
+            __props__.__dict__["rule_enable"] = rule_enable
+            __props__.__dict__["rule_name"] = rule_name
+            if site_id is None and not opts.urn:
+                raise TypeError("Missing required property 'site_id'")
+            __props__.__dict__["site_id"] = site_id
+            __props__.__dict__["site_version"] = site_version
+            __props__.__dict__["config_id"] = None
+        super(HttpRequestHeaderModificationRule, __self__).__init__(
+            'alicloud:esa/httpRequestHeaderModificationRule:HttpRequestHeaderModificationRule',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            config_id: Optional[pulumi.Input[int]] = None,
+            request_header_modifications: Optional[pulumi.Input[Sequence[pulumi.Input[Union['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs', 'HttpRequestHeaderModificationRuleRequestHeaderModificationArgsDict']]]]] = None,
+            rule: Optional[pulumi.Input[str]] = None,
+            rule_enable: Optional[pulumi.Input[str]] = None,
+            rule_name: Optional[pulumi.Input[str]] = None,
+            site_id: Optional[pulumi.Input[int]] = None,
+            site_version: Optional[pulumi.Input[int]] = None) -> 'HttpRequestHeaderModificationRule':
+        """
+        Get an existing HttpRequestHeaderModificationRule resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[int] config_id: Config Id
+        :param pulumi.Input[Sequence[pulumi.Input[Union['HttpRequestHeaderModificationRuleRequestHeaderModificationArgs', 'HttpRequestHeaderModificationRuleRequestHeaderModificationArgsDict']]]] request_header_modifications: The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        :param pulumi.Input[str] rule: The rule content.
+        :param pulumi.Input[str] rule_enable: Rule switch. Value range:
+               on: Open.
+               off: off.
+        :param pulumi.Input[str] rule_name: Rule Name.
+        :param pulumi.Input[int] site_id: The site ID, which can be obtained by calling the ListSites API.
+        :param pulumi.Input[int] site_version: The version number of the website configurations.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _HttpRequestHeaderModificationRuleState.__new__(_HttpRequestHeaderModificationRuleState)
+
+        __props__.__dict__["config_id"] = config_id
+        __props__.__dict__["request_header_modifications"] = request_header_modifications
+        __props__.__dict__["rule"] = rule
+        __props__.__dict__["rule_enable"] = rule_enable
+        __props__.__dict__["rule_name"] = rule_name
+        __props__.__dict__["site_id"] = site_id
+        __props__.__dict__["site_version"] = site_version
+        return HttpRequestHeaderModificationRule(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="configId")
+    def config_id(self) -> pulumi.Output[int]:
+        """
+        Config Id
+        """
+        return pulumi.get(self, "config_id")
+
+    @property
+    @pulumi.getter(name="requestHeaderModifications")
+    def request_header_modifications(self) -> pulumi.Output[Sequence['outputs.HttpRequestHeaderModificationRuleRequestHeaderModification']]:
+        """
+        The configurations of modifying request headers. You can add, delete, or modify a request header. See `request_header_modification` below.
+        """
+        return pulumi.get(self, "request_header_modifications")
+
+    @property
+    @pulumi.getter
+    def rule(self) -> pulumi.Output[Optional[str]]:
+        """
+        The rule content.
+        """
+        return pulumi.get(self, "rule")
+
+    @property
+    @pulumi.getter(name="ruleEnable")
+    def rule_enable(self) -> pulumi.Output[Optional[str]]:
+        """
+        Rule switch. Value range:
+        on: Open.
+        off: off.
+        """
+        return pulumi.get(self, "rule_enable")
+
+    @property
+    @pulumi.getter(name="ruleName")
+    def rule_name(self) -> pulumi.Output[Optional[str]]:
+        """
+        Rule Name.
+        """
+        return pulumi.get(self, "rule_name")
+
+    @property
+    @pulumi.getter(name="siteId")
+    def site_id(self) -> pulumi.Output[int]:
+        """
+        The site ID, which can be obtained by calling the ListSites API.
+        """
+        return pulumi.get(self, "site_id")
+
+    @property
+    @pulumi.getter(name="siteVersion")
+    def site_version(self) -> pulumi.Output[Optional[int]]:
+        """
+        The version number of the website configurations.
+        """
+        return pulumi.get(self, "site_version")
+