pulumi-alicloud 3.75.0a1741324537__py3-none-any.whl → 3.76.0__py3-none-any.whl

pulumi_alicloud/esa/image_transform.py

@@ -0,0 +1,498 @@
+# 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
+
+__all__ = ['ImageTransformArgs', 'ImageTransform']
+
+@pulumi.input_type
+class ImageTransformArgs:
+    def __init__(__self__, *,
+                 site_id: pulumi.Input[int],
+                 enable: Optional[pulumi.Input[str]] = None,
+                 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 ImageTransform resource.
+        :param pulumi.Input[int] site_id: The site ID, which can be obtained by calling the ListSites API.
+        :param pulumi.Input[str] enable: Indicates whether the image transformations feature is enabled. Valid values:
+        :param pulumi.Input[str] 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\\")
+        :param pulumi.Input[str] rule_enable: Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
+        :param pulumi.Input[str] rule_name: Rule name. When adding global configuration, this parameter does not need to be set.
+        :param pulumi.Input[int] site_version: 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.
+        """
+        pulumi.set(__self__, "site_id", site_id)
+        if enable is not None:
+            pulumi.set(__self__, "enable", enable)
+        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="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 enable(self) -> Optional[pulumi.Input[str]]:
+        """
+        Indicates whether the image transformations feature is enabled. Valid values:
+        """
+        return pulumi.get(self, "enable")
+
+    @enable.setter
+    def enable(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "enable", value)
+
+    @property
+    @pulumi.getter
+    def rule(self) -> Optional[pulumi.Input[str]]:
+        """
+        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\\")
+        """
+        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. When adding global configuration, this parameter does not need to be set. Value range:
+        """
+        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. When adding global configuration, this parameter does not need to be set.
+        """
+        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 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.
+        """
+        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 _ImageTransformState:
+    def __init__(__self__, *,
+                 config_id: Optional[pulumi.Input[int]] = None,
+                 enable: Optional[pulumi.Input[str]] = 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 ImageTransform resources.
+        :param pulumi.Input[int] config_id: Config Id
+        :param pulumi.Input[str] enable: Indicates whether the image transformations feature is enabled. Valid values:
+        :param pulumi.Input[str] 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\\")
+        :param pulumi.Input[str] rule_enable: Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
+        :param pulumi.Input[str] rule_name: Rule name. When adding global configuration, this parameter does not need to be set.
+        :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 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.
+        """
+        if config_id is not None:
+            pulumi.set(__self__, "config_id", config_id)
+        if enable is not None:
+            pulumi.set(__self__, "enable", enable)
+        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
+    def enable(self) -> Optional[pulumi.Input[str]]:
+        """
+        Indicates whether the image transformations feature is enabled. Valid values:
+        """
+        return pulumi.get(self, "enable")
+
+    @enable.setter
+    def enable(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "enable", value)
+
+    @property
+    @pulumi.getter
+    def rule(self) -> Optional[pulumi.Input[str]]:
+        """
+        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\\")
+        """
+        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. When adding global configuration, this parameter does not need to be set. Value range:
+        """
+        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. When adding global configuration, this parameter does not need to be set.
+        """
+        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 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.
+        """
+        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 ImageTransform(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 enable: Optional[pulumi.Input[str]] = 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 Image Transform resource.
+
+        For information about ESA Image Transform and how to use it, see [What is Image Transform](https://next.api.alibabacloud.com/document/ESA/2024-09-10/CreateImageTransform).
+
+        > **NOTE:** Available since v1.244.0.
+
+        ## Example Usage
+
+        Basic Usage
+
+        ```python
+        import pulumi
+        import pulumi_alicloud as alicloud
+
+        default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
+        default_site = alicloud.esa.Site("default",
+            site_name="imagetransform.tf.com",
+            instance_id=default.sites[0].instance_id,
+            coverage="domestic",
+            access_type="NS")
+        default_image_transform = alicloud.esa.ImageTransform("default",
+            rule="http.host eq \\"video.example.com\\"",
+            site_version=0,
+            rule_name="rule_example",
+            site_id=default_site.id,
+            rule_enable="off",
+            enable="off")
+        ```
+
+        ## Import
+
+        ESA Image Transform can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:esa/imageTransform:ImageTransform 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[str] enable: Indicates whether the image transformations feature is enabled. Valid values:
+        :param pulumi.Input[str] 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\\")
+        :param pulumi.Input[str] rule_enable: Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
+        :param pulumi.Input[str] rule_name: Rule name. When adding global configuration, this parameter does not need to be set.
+        :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 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.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: ImageTransformArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a ESA Image Transform resource.
+
+        For information about ESA Image Transform and how to use it, see [What is Image Transform](https://next.api.alibabacloud.com/document/ESA/2024-09-10/CreateImageTransform).
+
+        > **NOTE:** Available since v1.244.0.
+
+        ## Example Usage
+
+        Basic Usage
+
+        ```python
+        import pulumi
+        import pulumi_alicloud as alicloud
+
+        default = alicloud.esa.get_sites(plan_subscribe_type="enterpriseplan")
+        default_site = alicloud.esa.Site("default",
+            site_name="imagetransform.tf.com",
+            instance_id=default.sites[0].instance_id,
+            coverage="domestic",
+            access_type="NS")
+        default_image_transform = alicloud.esa.ImageTransform("default",
+            rule="http.host eq \\"video.example.com\\"",
+            site_version=0,
+            rule_name="rule_example",
+            site_id=default_site.id,
+            rule_enable="off",
+            enable="off")
+        ```
+
+        ## Import
+
+        ESA Image Transform can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:esa/imageTransform:ImageTransform example <site_id>:<config_id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param ImageTransformArgs 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(ImageTransformArgs, 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,
+                 enable: Optional[pulumi.Input[str]] = 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__ = ImageTransformArgs.__new__(ImageTransformArgs)
+
+            __props__.__dict__["enable"] = enable
+            __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(ImageTransform, __self__).__init__(
+            'alicloud:esa/imageTransform:ImageTransform',
+            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,
+            enable: Optional[pulumi.Input[str]] = 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) -> 'ImageTransform':
+        """
+        Get an existing ImageTransform 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[str] enable: Indicates whether the image transformations feature is enabled. Valid values:
+        :param pulumi.Input[str] 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\\")
+        :param pulumi.Input[str] rule_enable: Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
+        :param pulumi.Input[str] rule_name: Rule name. When adding global configuration, this parameter does not need to be set.
+        :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 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.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _ImageTransformState.__new__(_ImageTransformState)
+
+        __props__.__dict__["config_id"] = config_id
+        __props__.__dict__["enable"] = enable
+        __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 ImageTransform(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
+    def enable(self) -> pulumi.Output[Optional[str]]:
+        """
+        Indicates whether the image transformations feature is enabled. Valid values:
+        """
+        return pulumi.get(self, "enable")
+
+    @property
+    @pulumi.getter
+    def rule(self) -> pulumi.Output[Optional[str]]:
+        """
+        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\\")
+        """
+        return pulumi.get(self, "rule")
+
+    @property
+    @pulumi.getter(name="ruleEnable")
+    def rule_enable(self) -> pulumi.Output[Optional[str]]:
+        """
+        Rule switch. When adding global configuration, this parameter does not need to be set. Value range:
+        """
+        return pulumi.get(self, "rule_enable")
+
+    @property
+    @pulumi.getter(name="ruleName")
+    def rule_name(self) -> pulumi.Output[Optional[str]]:
+        """
+        Rule name. When adding global configuration, this parameter does not need to be set.
+        """
+        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 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.
+        """
+        return pulumi.get(self, "site_version")
+