pulumi-scm 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

pulumi_scm/service_route.py

@@ -0,0 +1,492 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+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__ = ['ServiceRouteArgs', 'ServiceRoute']
+
+@pulumi.input_type
+class ServiceRouteArgs:
+    def __init__(__self__, *,
+                 device: Optional[pulumi.Input[_builtins.str]] = None,
+                 folder: Optional[pulumi.Input[_builtins.str]] = None,
+                 route: Optional[pulumi.Input['ServiceRouteRouteArgs']] = None,
+                 snippet: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        The set of arguments for constructing a ServiceRoute resource.
+        :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
+        :param pulumi.Input[_builtins.str] folder: The folder in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        :param pulumi.Input['ServiceRouteRouteArgs'] route: Route
+        :param pulumi.Input[_builtins.str] snippet: The snippet in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        if device is not None:
+            pulumi.set(__self__, "device", device)
+        if folder is not None:
+            pulumi.set(__self__, "folder", folder)
+        if route is not None:
+            pulumi.set(__self__, "route", route)
+        if snippet is not None:
+            pulumi.set(__self__, "snippet", snippet)
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The device in which the resource is defined
+        """
+        return pulumi.get(self, "device")
+
+    @device.setter
+    def device(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "device", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The folder in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "folder")
+
+    @folder.setter
+    def folder(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "folder", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def route(self) -> Optional[pulumi.Input['ServiceRouteRouteArgs']]:
+        """
+        Route
+        """
+        return pulumi.get(self, "route")
+
+    @route.setter
+    def route(self, value: Optional[pulumi.Input['ServiceRouteRouteArgs']]):
+        pulumi.set(self, "route", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The snippet in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "snippet")
+
+    @snippet.setter
+    def snippet(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "snippet", value)
+
+
+@pulumi.input_type
+class _ServiceRouteState:
+    def __init__(__self__, *,
+                 device: Optional[pulumi.Input[_builtins.str]] = None,
+                 folder: Optional[pulumi.Input[_builtins.str]] = None,
+                 route: Optional[pulumi.Input['ServiceRouteRouteArgs']] = None,
+                 snippet: Optional[pulumi.Input[_builtins.str]] = None,
+                 tfid: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering ServiceRoute resources.
+        :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
+        :param pulumi.Input[_builtins.str] folder: The folder in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        :param pulumi.Input['ServiceRouteRouteArgs'] route: Route
+        :param pulumi.Input[_builtins.str] snippet: The snippet in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        if device is not None:
+            pulumi.set(__self__, "device", device)
+        if folder is not None:
+            pulumi.set(__self__, "folder", folder)
+        if route is not None:
+            pulumi.set(__self__, "route", route)
+        if snippet is not None:
+            pulumi.set(__self__, "snippet", snippet)
+        if tfid is not None:
+            pulumi.set(__self__, "tfid", tfid)
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The device in which the resource is defined
+        """
+        return pulumi.get(self, "device")
+
+    @device.setter
+    def device(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "device", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The folder in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "folder")
+
+    @folder.setter
+    def folder(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "folder", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def route(self) -> Optional[pulumi.Input['ServiceRouteRouteArgs']]:
+        """
+        Route
+        """
+        return pulumi.get(self, "route")
+
+    @route.setter
+    def route(self, value: Optional[pulumi.Input['ServiceRouteRouteArgs']]):
+        pulumi.set(self, "route", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The snippet in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "snippet")
+
+    @snippet.setter
+    def snippet(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "snippet", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def tfid(self) -> Optional[pulumi.Input[_builtins.str]]:
+        return pulumi.get(self, "tfid")
+
+    @tfid.setter
+    def tfid(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "tfid", value)
+
+
+@pulumi.type_token("scm:index/serviceRoute:ServiceRoute")
+class ServiceRoute(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 device: Optional[pulumi.Input[_builtins.str]] = None,
+                 folder: Optional[pulumi.Input[_builtins.str]] = None,
+                 route: Optional[pulumi.Input[Union['ServiceRouteRouteArgs', 'ServiceRouteRouteArgsDict']]] = None,
+                 snippet: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        ServiceRoute resource
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_scm as scm
+
+        sr_ethernet_interface1 = scm.EthernetInterface("sr_ethernet_interface_1",
+            name="$layer3_sr_1",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            link_speed="auto",
+            link_duplex="full",
+            link_state="auto",
+            layer3={
+                "ips": [{
+                    "name": "10.10.10.10",
+                }],
+            })
+        sr_ethernet_interface2 = scm.EthernetInterface("sr_ethernet_interface_2",
+            name="$layer3_sr_2",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            link_speed="auto",
+            link_duplex="full",
+            link_state="auto",
+            layer3={
+                "ips": [{
+                    "name": "10.10.10.20",
+                }],
+            })
+        sr_settings = scm.ServiceRoute("sr_settings",
+            folder="ngfw-shared",
+            route={
+                "services": [{
+                    "name": "ddns",
+                    "source": {
+                        "interface": sr_ethernet_interface1.name,
+                        "address": "10.10.10.10",
+                    },
+                }],
+                "destinations": [{
+                    "name": sr_ethernet_interface2.name,
+                    "source": {
+                        "address": "10.10.10.20",
+                    },
+                }],
+            })
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example ::device:id
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
+        :param pulumi.Input[_builtins.str] folder: The folder in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        :param pulumi.Input[Union['ServiceRouteRouteArgs', 'ServiceRouteRouteArgsDict']] route: Route
+        :param pulumi.Input[_builtins.str] snippet: The snippet in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[ServiceRouteArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ServiceRoute resource
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_scm as scm
+
+        sr_ethernet_interface1 = scm.EthernetInterface("sr_ethernet_interface_1",
+            name="$layer3_sr_1",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            link_speed="auto",
+            link_duplex="full",
+            link_state="auto",
+            layer3={
+                "ips": [{
+                    "name": "10.10.10.10",
+                }],
+            })
+        sr_ethernet_interface2 = scm.EthernetInterface("sr_ethernet_interface_2",
+            name="$layer3_sr_2",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            link_speed="auto",
+            link_duplex="full",
+            link_state="auto",
+            layer3={
+                "ips": [{
+                    "name": "10.10.10.20",
+                }],
+            })
+        sr_settings = scm.ServiceRoute("sr_settings",
+            folder="ngfw-shared",
+            route={
+                "services": [{
+                    "name": "ddns",
+                    "source": {
+                        "interface": sr_ethernet_interface1.name,
+                        "address": "10.10.10.10",
+                    },
+                }],
+                "destinations": [{
+                    "name": sr_ethernet_interface2.name,
+                    "source": {
+                        "address": "10.10.10.20",
+                    },
+                }],
+            })
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/serviceRoute:ServiceRoute example ::device:id
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param ServiceRouteArgs 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(ServiceRouteArgs, 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,
+                 device: Optional[pulumi.Input[_builtins.str]] = None,
+                 folder: Optional[pulumi.Input[_builtins.str]] = None,
+                 route: Optional[pulumi.Input[Union['ServiceRouteRouteArgs', 'ServiceRouteRouteArgsDict']]] = None,
+                 snippet: Optional[pulumi.Input[_builtins.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__ = ServiceRouteArgs.__new__(ServiceRouteArgs)
+
+            __props__.__dict__["device"] = device
+            __props__.__dict__["folder"] = folder
+            __props__.__dict__["route"] = route
+            __props__.__dict__["snippet"] = snippet
+            __props__.__dict__["tfid"] = None
+        super(ServiceRoute, __self__).__init__(
+            'scm:index/serviceRoute:ServiceRoute',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            device: Optional[pulumi.Input[_builtins.str]] = None,
+            folder: Optional[pulumi.Input[_builtins.str]] = None,
+            route: Optional[pulumi.Input[Union['ServiceRouteRouteArgs', 'ServiceRouteRouteArgsDict']]] = None,
+            snippet: Optional[pulumi.Input[_builtins.str]] = None,
+            tfid: Optional[pulumi.Input[_builtins.str]] = None) -> 'ServiceRoute':
+        """
+        Get an existing ServiceRoute 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[_builtins.str] device: The device in which the resource is defined
+        :param pulumi.Input[_builtins.str] folder: The folder in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        :param pulumi.Input[Union['ServiceRouteRouteArgs', 'ServiceRouteRouteArgsDict']] route: Route
+        :param pulumi.Input[_builtins.str] snippet: The snippet in which the resource is defined
+               
+               > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _ServiceRouteState.__new__(_ServiceRouteState)
+
+        __props__.__dict__["device"] = device
+        __props__.__dict__["folder"] = folder
+        __props__.__dict__["route"] = route
+        __props__.__dict__["snippet"] = snippet
+        __props__.__dict__["tfid"] = tfid
+        return ServiceRoute(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The device in which the resource is defined
+        """
+        return pulumi.get(self, "device")
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The folder in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "folder")
+
+    @_builtins.property
+    @pulumi.getter
+    def route(self) -> pulumi.Output[Optional['outputs.ServiceRouteRoute']]:
+        """
+        Route
+        """
+        return pulumi.get(self, "route")
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The snippet in which the resource is defined
+
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "snippet")
+
+    @_builtins.property
+    @pulumi.getter
+    def tfid(self) -> pulumi.Output[_builtins.str]:
+        return pulumi.get(self, "tfid")
+