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

pulumi_scm/get_decryption_rule.py

@@ -161,22 +161,33 @@ class GetDecryptionRuleResult:
     def device(self) -> _builtins.str:
         """
         The device in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
         """
         return pulumi.get(self, "device")
 
     @_builtins.property
     @pulumi.getter
     def disabled(self) -> _builtins.bool:
+        """
+        Is the rule disabled?
+        """
         return pulumi.get(self, "disabled")
 
     @_builtins.property
     @pulumi.getter
     def folder(self) -> _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 froms(self) -> Sequence[_builtins.str]:
+        """
+        The source security zone
+        """
         return pulumi.get(self, "froms")
 
     @_builtins.property
@@ -190,16 +201,25 @@ class GetDecryptionRuleResult:
     @_builtins.property
     @pulumi.getter(name="logFail")
     def log_fail(self) -> _builtins.bool:
+        """
+        Log failed decryption events?
+        """
         return pulumi.get(self, "log_fail")
 
     @_builtins.property
     @pulumi.getter(name="logSetting")
     def log_setting(self) -> _builtins.str:
+        """
+        The log settings of the decryption rule
+        """
         return pulumi.get(self, "log_setting")
 
     @_builtins.property
     @pulumi.getter(name="logSuccess")
     def log_success(self) -> _builtins.bool:
+        """
+        Log successful decryption events?
+        """
         return pulumi.get(self, "log_success")
 
     @_builtins.property
@@ -213,61 +233,98 @@ class GetDecryptionRuleResult:
     @_builtins.property
     @pulumi.getter(name="negateDestination")
     def negate_destination(self) -> _builtins.bool:
+        """
+        Negate the destination addresses?
+        """
         return pulumi.get(self, "negate_destination")
 
     @_builtins.property
     @pulumi.getter(name="negateSource")
     def negate_source(self) -> _builtins.bool:
+        """
+        Negate the source addresses?
+        """
         return pulumi.get(self, "negate_source")
 
     @_builtins.property
     @pulumi.getter
     def position(self) -> _builtins.str:
+        """
+        The position of a security rule
+        """
         return pulumi.get(self, "position")
 
     @_builtins.property
     @pulumi.getter
     def profile(self) -> _builtins.str:
+        """
+        The decryption profile associated with the decryption rule
+        """
         return pulumi.get(self, "profile")
 
     @_builtins.property
     @pulumi.getter(name="relativePosition")
     def relative_position(self) -> _builtins.str:
+        """
+        Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset.
+        """
         return pulumi.get(self, "relative_position")
 
     @_builtins.property
     @pulumi.getter
     def services(self) -> Sequence[_builtins.str]:
+        """
+        The destination services and/or service groups
+        """
         return pulumi.get(self, "services")
 
     @_builtins.property
     @pulumi.getter
     def snippet(self) -> _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(name="sourceHips")
     def source_hips(self) -> Sequence[_builtins.str]:
+        """
+        Source hip
+        """
         return pulumi.get(self, "source_hips")
 
     @_builtins.property
     @pulumi.getter(name="sourceUsers")
     def source_users(self) -> Sequence[_builtins.str]:
+        """
+        List of source users and/or groups.  Reserved words include `any`, `pre-login`, `known-user`, and `unknown`.
+        """
         return pulumi.get(self, "source_users")
 
     @_builtins.property
     @pulumi.getter
     def sources(self) -> Sequence[_builtins.str]:
+        """
+        The source addresses
+        """
         return pulumi.get(self, "sources")
 
     @_builtins.property
     @pulumi.getter
     def tags(self) -> Sequence[_builtins.str]:
+        """
+        The tags associated with the decryption rule
+        """
         return pulumi.get(self, "tags")
 
     @_builtins.property
     @pulumi.getter(name="targetRule")
     def target_rule(self) -> _builtins.str:
+        """
+        The name or UUID of the rule to position this rule relative to. Required when `relative_position` is `"before"` or `"after"`.
+        """
         return pulumi.get(self, "target_rule")
 
     @_builtins.property
@@ -278,11 +335,17 @@ class GetDecryptionRuleResult:
     @_builtins.property
     @pulumi.getter
     def tos(self) -> Sequence[_builtins.str]:
+        """
+        The destination security zone
+        """
         return pulumi.get(self, "tos")
 
     @_builtins.property
     @pulumi.getter
     def type(self) -> 'outputs.GetDecryptionRuleTypeResult':
+        """
+        The type of decryption
+        """
         return pulumi.get(self, "type")
 
 
@@ -323,8 +386,11 @@ class AwaitableGetDecryptionRuleResult(GetDecryptionRuleResult):
             type=self.type)
 
 
-def get_decryption_rule(id: Optional[_builtins.str] = None,
+def get_decryption_rule(device: Optional[_builtins.str] = None,
+                        folder: Optional[_builtins.str] = None,
+                        id: Optional[_builtins.str] = None,
                         name: Optional[_builtins.str] = None,
+                        snippet: Optional[_builtins.str] = None,
                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDecryptionRuleResult:
     """
     DecryptionRule data source
@@ -341,12 +407,21 @@ def get_decryption_rule(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the decryption rule
     :param _builtins.str name: The name of the decryption rule
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('scm:index/getDecryptionRule:getDecryptionRule', __args__, opts=opts, typ=GetDecryptionRuleResult).value
 
@@ -380,8 +455,11 @@ def get_decryption_rule(id: Optional[_builtins.str] = None,
         tfid=pulumi.get(__ret__, 'tfid'),
         tos=pulumi.get(__ret__, 'tos'),
         type=pulumi.get(__ret__, 'type'))
-def get_decryption_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_decryption_rule_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                               folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                               id: Optional[pulumi.Input[_builtins.str]] = None,
                                name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                               snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDecryptionRuleResult]:
     """
     DecryptionRule data source
@@ -398,12 +476,21 @@ def get_decryption_rule_output(id: Optional[pulumi.Input[_builtins.str]] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     :param _builtins.str id: The UUID of the decryption rule
     :param _builtins.str name: The name of the decryption rule
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('scm:index/getDecryptionRule:getDecryptionRule', __args__, opts=opts, typ=GetDecryptionRuleResult)
     return __ret__.apply(lambda __response__: GetDecryptionRuleResult(

pulumi_scm/get_device_redistribution_collector.py

@@ -0,0 +1,195 @@
+# 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
+
+__all__ = [
+    'GetDeviceRedistributionCollectorResult',
+    'AwaitableGetDeviceRedistributionCollectorResult',
+    'get_device_redistribution_collector',
+    'get_device_redistribution_collector_output',
+]
+
+@pulumi.output_type
+class GetDeviceRedistributionCollectorResult:
+    """
+    A collection of values returned by getDeviceRedistributionCollector.
+    """
+    def __init__(__self__, device=None, folder=None, id=None, redistribution_collector=None, snippet=None, tfid=None):
+        if device and not isinstance(device, str):
+            raise TypeError("Expected argument 'device' to be a str")
+        pulumi.set(__self__, "device", device)
+        if folder and not isinstance(folder, str):
+            raise TypeError("Expected argument 'folder' to be a str")
+        pulumi.set(__self__, "folder", folder)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if redistribution_collector and not isinstance(redistribution_collector, dict):
+            raise TypeError("Expected argument 'redistribution_collector' to be a dict")
+        pulumi.set(__self__, "redistribution_collector", redistribution_collector)
+        if snippet and not isinstance(snippet, str):
+            raise TypeError("Expected argument 'snippet' to be a str")
+        pulumi.set(__self__, "snippet", snippet)
+        if tfid and not isinstance(tfid, str):
+            raise TypeError("Expected argument 'tfid' to be a str")
+        pulumi.set(__self__, "tfid", tfid)
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> _builtins.str:
+        """
+        The device in which the resource is defined
+        > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+        """
+        return pulumi.get(self, "device")
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> _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 id(self) -> _builtins.str:
+        """
+        UUID of the resource
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="redistributionCollector")
+    def redistribution_collector(self) -> 'outputs.GetDeviceRedistributionCollectorRedistributionCollectorResult':
+        """
+        Redistribution collector
+        """
+        return pulumi.get(self, "redistribution_collector")
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> _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) -> _builtins.str:
+        return pulumi.get(self, "tfid")
+
+
+class AwaitableGetDeviceRedistributionCollectorResult(GetDeviceRedistributionCollectorResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDeviceRedistributionCollectorResult(
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            redistribution_collector=self.redistribution_collector,
+            snippet=self.snippet,
+            tfid=self.tfid)
+
+
+def get_device_redistribution_collector(device: Optional[_builtins.str] = None,
+                                        folder: Optional[_builtins.str] = None,
+                                        id: Optional[_builtins.str] = None,
+                                        snippet: Optional[_builtins.str] = None,
+                                        opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDeviceRedistributionCollectorResult:
+    """
+    DeviceRedistributionCollector data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_device_redistribution_collector(id="8c1f7d95-83bd-4ae6-877c-89e1a212ef14")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str id: UUID of the resource
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scm:index/getDeviceRedistributionCollector:getDeviceRedistributionCollector', __args__, opts=opts, typ=GetDeviceRedistributionCollectorResult).value
+
+    return AwaitableGetDeviceRedistributionCollectorResult(
+        device=pulumi.get(__ret__, 'device'),
+        folder=pulumi.get(__ret__, 'folder'),
+        id=pulumi.get(__ret__, 'id'),
+        redistribution_collector=pulumi.get(__ret__, 'redistribution_collector'),
+        snippet=pulumi.get(__ret__, 'snippet'),
+        tfid=pulumi.get(__ret__, 'tfid'))
+def get_device_redistribution_collector_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                               folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                               id: Optional[pulumi.Input[_builtins.str]] = None,
+                                               snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                               opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDeviceRedistributionCollectorResult]:
+    """
+    DeviceRedistributionCollector data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_device_redistribution_collector(id="8c1f7d95-83bd-4ae6-877c-89e1a212ef14")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str folder: The folder in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    :param _builtins.str id: UUID of the resource
+    :param _builtins.str snippet: The snippet in which the resource is defined
+           > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scm:index/getDeviceRedistributionCollector:getDeviceRedistributionCollector', __args__, opts=opts, typ=GetDeviceRedistributionCollectorResult)
+    return __ret__.apply(lambda __response__: GetDeviceRedistributionCollectorResult(
+        device=pulumi.get(__response__, 'device'),
+        folder=pulumi.get(__response__, 'folder'),
+        id=pulumi.get(__response__, 'id'),
+        redistribution_collector=pulumi.get(__response__, 'redistribution_collector'),
+        snippet=pulumi.get(__response__, 'snippet'),
+        tfid=pulumi.get(__response__, 'tfid')))