pulumi-alicloud 3.66.0a1731648019__py3-none-any.whl → 3.66.0a1731672315__py3-none-any.whl

pulumi_alicloud/gwlb/listener.py

@@ -0,0 +1,434 @@
+# 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__ = ['ListenerArgs', 'Listener']
+
+@pulumi.input_type
+class ListenerArgs:
+    def __init__(__self__, *,
+                 load_balancer_id: pulumi.Input[str],
+                 server_group_id: pulumi.Input[str],
+                 dry_run: Optional[pulumi.Input[bool]] = None,
+                 listener_description: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None):
+        """
+        The set of arguments for constructing a Listener resource.
+        :param pulumi.Input[str] load_balancer_id: The ID of the gateway load balancer instance.
+        :param pulumi.Input[str] server_group_id: The ID of the server group.
+        :param pulumi.Input[bool] dry_run: Specifies whether to perform only a dry run, without performing the actual request.
+        :param pulumi.Input[str] listener_description: The custom listener description.
+               
+               The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: The list of tags.
+        """
+        pulumi.set(__self__, "load_balancer_id", load_balancer_id)
+        pulumi.set(__self__, "server_group_id", server_group_id)
+        if dry_run is not None:
+            pulumi.set(__self__, "dry_run", dry_run)
+        if listener_description is not None:
+            pulumi.set(__self__, "listener_description", listener_description)
+        if tags is not None:
+            pulumi.set(__self__, "tags", tags)
+
+    @property
+    @pulumi.getter(name="loadBalancerId")
+    def load_balancer_id(self) -> pulumi.Input[str]:
+        """
+        The ID of the gateway load balancer instance.
+        """
+        return pulumi.get(self, "load_balancer_id")
+
+    @load_balancer_id.setter
+    def load_balancer_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "load_balancer_id", value)
+
+    @property
+    @pulumi.getter(name="serverGroupId")
+    def server_group_id(self) -> pulumi.Input[str]:
+        """
+        The ID of the server group.
+        """
+        return pulumi.get(self, "server_group_id")
+
+    @server_group_id.setter
+    def server_group_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "server_group_id", value)
+
+    @property
+    @pulumi.getter(name="dryRun")
+    def dry_run(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Specifies whether to perform only a dry run, without performing the actual request.
+        """
+        return pulumi.get(self, "dry_run")
+
+    @dry_run.setter
+    def dry_run(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "dry_run", value)
+
+    @property
+    @pulumi.getter(name="listenerDescription")
+    def listener_description(self) -> Optional[pulumi.Input[str]]:
+        """
+        The custom listener description.
+
+        The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        """
+        return pulumi.get(self, "listener_description")
+
+    @listener_description.setter
+    def listener_description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "listener_description", value)
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        The list of tags.
+        """
+        return pulumi.get(self, "tags")
+
+    @tags.setter
+    def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "tags", value)
+
+
+@pulumi.input_type
+class _ListenerState:
+    def __init__(__self__, *,
+                 dry_run: Optional[pulumi.Input[bool]] = None,
+                 listener_description: Optional[pulumi.Input[str]] = None,
+                 load_balancer_id: Optional[pulumi.Input[str]] = None,
+                 region_id: Optional[pulumi.Input[str]] = None,
+                 server_group_id: Optional[pulumi.Input[str]] = None,
+                 status: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None):
+        """
+        Input properties used for looking up and filtering Listener resources.
+        :param pulumi.Input[bool] dry_run: Specifies whether to perform only a dry run, without performing the actual request.
+        :param pulumi.Input[str] listener_description: The custom listener description.
+               
+               The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        :param pulumi.Input[str] load_balancer_id: The ID of the gateway load balancer instance.
+        :param pulumi.Input[str] region_id: The ID of the region.
+        :param pulumi.Input[str] server_group_id: The ID of the server group.
+        :param pulumi.Input[str] status: The current status of the listener. Value:
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: The list of tags.
+        """
+        if dry_run is not None:
+            pulumi.set(__self__, "dry_run", dry_run)
+        if listener_description is not None:
+            pulumi.set(__self__, "listener_description", listener_description)
+        if load_balancer_id is not None:
+            pulumi.set(__self__, "load_balancer_id", load_balancer_id)
+        if region_id is not None:
+            pulumi.set(__self__, "region_id", region_id)
+        if server_group_id is not None:
+            pulumi.set(__self__, "server_group_id", server_group_id)
+        if status is not None:
+            pulumi.set(__self__, "status", status)
+        if tags is not None:
+            pulumi.set(__self__, "tags", tags)
+
+    @property
+    @pulumi.getter(name="dryRun")
+    def dry_run(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Specifies whether to perform only a dry run, without performing the actual request.
+        """
+        return pulumi.get(self, "dry_run")
+
+    @dry_run.setter
+    def dry_run(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "dry_run", value)
+
+    @property
+    @pulumi.getter(name="listenerDescription")
+    def listener_description(self) -> Optional[pulumi.Input[str]]:
+        """
+        The custom listener description.
+
+        The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        """
+        return pulumi.get(self, "listener_description")
+
+    @listener_description.setter
+    def listener_description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "listener_description", value)
+
+    @property
+    @pulumi.getter(name="loadBalancerId")
+    def load_balancer_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the gateway load balancer instance.
+        """
+        return pulumi.get(self, "load_balancer_id")
+
+    @load_balancer_id.setter
+    def load_balancer_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "load_balancer_id", value)
+
+    @property
+    @pulumi.getter(name="regionId")
+    def region_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the region.
+        """
+        return pulumi.get(self, "region_id")
+
+    @region_id.setter
+    def region_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region_id", value)
+
+    @property
+    @pulumi.getter(name="serverGroupId")
+    def server_group_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the server group.
+        """
+        return pulumi.get(self, "server_group_id")
+
+    @server_group_id.setter
+    def server_group_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "server_group_id", value)
+
+    @property
+    @pulumi.getter
+    def status(self) -> Optional[pulumi.Input[str]]:
+        """
+        The current status of the listener. Value:
+        """
+        return pulumi.get(self, "status")
+
+    @status.setter
+    def status(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "status", value)
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
+        """
+        The list of tags.
+        """
+        return pulumi.get(self, "tags")
+
+    @tags.setter
+    def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "tags", value)
+
+
+class Listener(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 dry_run: Optional[pulumi.Input[bool]] = None,
+                 listener_description: Optional[pulumi.Input[str]] = None,
+                 load_balancer_id: Optional[pulumi.Input[str]] = None,
+                 server_group_id: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 __props__=None):
+        """
+        Provides a GWLB Listener resource.
+
+        For information about GWLB Listener and how to use it, see [What is Listener](https://www.alibabacloud.com/help/en/).
+
+        > **NOTE:** Available since v1.234.0.
+
+        ## Import
+
+        GWLB Listener can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:gwlb/listener:Listener example <id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[bool] dry_run: Specifies whether to perform only a dry run, without performing the actual request.
+        :param pulumi.Input[str] listener_description: The custom listener description.
+               
+               The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        :param pulumi.Input[str] load_balancer_id: The ID of the gateway load balancer instance.
+        :param pulumi.Input[str] server_group_id: The ID of the server group.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: The list of tags.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: ListenerArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Provides a GWLB Listener resource.
+
+        For information about GWLB Listener and how to use it, see [What is Listener](https://www.alibabacloud.com/help/en/).
+
+        > **NOTE:** Available since v1.234.0.
+
+        ## Import
+
+        GWLB Listener can be imported using the id, e.g.
+
+        ```sh
+        $ pulumi import alicloud:gwlb/listener:Listener example <id>
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param ListenerArgs 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(ListenerArgs, 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,
+                 dry_run: Optional[pulumi.Input[bool]] = None,
+                 listener_description: Optional[pulumi.Input[str]] = None,
+                 load_balancer_id: Optional[pulumi.Input[str]] = None,
+                 server_group_id: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = 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__ = ListenerArgs.__new__(ListenerArgs)
+
+            __props__.__dict__["dry_run"] = dry_run
+            __props__.__dict__["listener_description"] = listener_description
+            if load_balancer_id is None and not opts.urn:
+                raise TypeError("Missing required property 'load_balancer_id'")
+            __props__.__dict__["load_balancer_id"] = load_balancer_id
+            if server_group_id is None and not opts.urn:
+                raise TypeError("Missing required property 'server_group_id'")
+            __props__.__dict__["server_group_id"] = server_group_id
+            __props__.__dict__["tags"] = tags
+            __props__.__dict__["region_id"] = None
+            __props__.__dict__["status"] = None
+        super(Listener, __self__).__init__(
+            'alicloud:gwlb/listener:Listener',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            dry_run: Optional[pulumi.Input[bool]] = None,
+            listener_description: Optional[pulumi.Input[str]] = None,
+            load_balancer_id: Optional[pulumi.Input[str]] = None,
+            region_id: Optional[pulumi.Input[str]] = None,
+            server_group_id: Optional[pulumi.Input[str]] = None,
+            status: Optional[pulumi.Input[str]] = None,
+            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None) -> 'Listener':
+        """
+        Get an existing Listener 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[bool] dry_run: Specifies whether to perform only a dry run, without performing the actual request.
+        :param pulumi.Input[str] listener_description: The custom listener description.
+               
+               The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        :param pulumi.Input[str] load_balancer_id: The ID of the gateway load balancer instance.
+        :param pulumi.Input[str] region_id: The ID of the region.
+        :param pulumi.Input[str] server_group_id: The ID of the server group.
+        :param pulumi.Input[str] status: The current status of the listener. Value:
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: The list of tags.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _ListenerState.__new__(_ListenerState)
+
+        __props__.__dict__["dry_run"] = dry_run
+        __props__.__dict__["listener_description"] = listener_description
+        __props__.__dict__["load_balancer_id"] = load_balancer_id
+        __props__.__dict__["region_id"] = region_id
+        __props__.__dict__["server_group_id"] = server_group_id
+        __props__.__dict__["status"] = status
+        __props__.__dict__["tags"] = tags
+        return Listener(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="dryRun")
+    def dry_run(self) -> pulumi.Output[Optional[bool]]:
+        """
+        Specifies whether to perform only a dry run, without performing the actual request.
+        """
+        return pulumi.get(self, "dry_run")
+
+    @property
+    @pulumi.getter(name="listenerDescription")
+    def listener_description(self) -> pulumi.Output[Optional[str]]:
+        """
+        The custom listener description.
+
+        The length is limited to 2 to 256 characters. It supports Chinese and English letters and can contain numbers, half-width commas (,), half-width periods (.), half-width semicolons (;), forward slashes (/), at(@), underscores (_), and dashes (-).
+        """
+        return pulumi.get(self, "listener_description")
+
+    @property
+    @pulumi.getter(name="loadBalancerId")
+    def load_balancer_id(self) -> pulumi.Output[str]:
+        """
+        The ID of the gateway load balancer instance.
+        """
+        return pulumi.get(self, "load_balancer_id")
+
+    @property
+    @pulumi.getter(name="regionId")
+    def region_id(self) -> pulumi.Output[str]:
+        """
+        The ID of the region.
+        """
+        return pulumi.get(self, "region_id")
+
+    @property
+    @pulumi.getter(name="serverGroupId")
+    def server_group_id(self) -> pulumi.Output[str]:
+        """
+        The ID of the server group.
+        """
+        return pulumi.get(self, "server_group_id")
+
+    @property
+    @pulumi.getter
+    def status(self) -> pulumi.Output[str]:
+        """
+        The current status of the listener. Value:
+        """
+        return pulumi.get(self, "status")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
+        """
+        The list of tags.
+        """
+        return pulumi.get(self, "tags")
+