pulumiverse-scaleway 1.24.0a1741680905__py3-none-any.whl → 1.25.0__py3-none-any.whl

pulumiverse_scaleway/instance/security_group_rules.py

@@ -0,0 +1,441 @@
+# 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__ = ['SecurityGroupRulesArgs', 'SecurityGroupRules']
+
+@pulumi.input_type
+class SecurityGroupRulesArgs:
+    def __init__(__self__, *,
+                 security_group_id: pulumi.Input[str],
+                 inbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]] = None,
+                 outbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]] = None):
+        """
+        The set of arguments for constructing a SecurityGroupRules resource.
+        :param pulumi.Input[str] security_group_id: The ID of the security group.
+        :param pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]] inbound_rules: A list of inbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]] outbound_rules: A list of outbound rule to add to the security group. (Structure is documented below.)
+        """
+        pulumi.set(__self__, "security_group_id", security_group_id)
+        if inbound_rules is not None:
+            pulumi.set(__self__, "inbound_rules", inbound_rules)
+        if outbound_rules is not None:
+            pulumi.set(__self__, "outbound_rules", outbound_rules)
+
+    @property
+    @pulumi.getter(name="securityGroupId")
+    def security_group_id(self) -> pulumi.Input[str]:
+        """
+        The ID of the security group.
+        """
+        return pulumi.get(self, "security_group_id")
+
+    @security_group_id.setter
+    def security_group_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "security_group_id", value)
+
+    @property
+    @pulumi.getter(name="inboundRules")
+    def inbound_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]]:
+        """
+        A list of inbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "inbound_rules")
+
+    @inbound_rules.setter
+    def inbound_rules(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]]):
+        pulumi.set(self, "inbound_rules", value)
+
+    @property
+    @pulumi.getter(name="outboundRules")
+    def outbound_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]]:
+        """
+        A list of outbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "outbound_rules")
+
+    @outbound_rules.setter
+    def outbound_rules(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]]):
+        pulumi.set(self, "outbound_rules", value)
+
+
+@pulumi.input_type
+class _SecurityGroupRulesState:
+    def __init__(__self__, *,
+                 inbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]] = None,
+                 outbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]] = None,
+                 security_group_id: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering SecurityGroupRules resources.
+        :param pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]] inbound_rules: A list of inbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]] outbound_rules: A list of outbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[str] security_group_id: The ID of the security group.
+        """
+        if inbound_rules is not None:
+            pulumi.set(__self__, "inbound_rules", inbound_rules)
+        if outbound_rules is not None:
+            pulumi.set(__self__, "outbound_rules", outbound_rules)
+        if security_group_id is not None:
+            pulumi.set(__self__, "security_group_id", security_group_id)
+
+    @property
+    @pulumi.getter(name="inboundRules")
+    def inbound_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]]:
+        """
+        A list of inbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "inbound_rules")
+
+    @inbound_rules.setter
+    def inbound_rules(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesInboundRuleArgs']]]]):
+        pulumi.set(self, "inbound_rules", value)
+
+    @property
+    @pulumi.getter(name="outboundRules")
+    def outbound_rules(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]]:
+        """
+        A list of outbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "outbound_rules")
+
+    @outbound_rules.setter
+    def outbound_rules(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecurityGroupRulesOutboundRuleArgs']]]]):
+        pulumi.set(self, "outbound_rules", value)
+
+    @property
+    @pulumi.getter(name="securityGroupId")
+    def security_group_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the security group.
+        """
+        return pulumi.get(self, "security_group_id")
+
+    @security_group_id.setter
+    def security_group_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "security_group_id", value)
+
+
+class SecurityGroupRules(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 inbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesInboundRuleArgs', 'SecurityGroupRulesInboundRuleArgsDict']]]]] = None,
+                 outbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesOutboundRuleArgs', 'SecurityGroupRulesOutboundRuleArgsDict']]]]] = None,
+                 security_group_id: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        Creates and manages Scaleway compute Instance security group rules. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-security-groups-list-security-groups).
+
+        This resource can be used to externalize rules from a `instance.SecurityGroup` to solve circular dependency problems. When using this resource do not forget to set `external_rules = true` on the security group.
+
+        > **Warning:** In order to guaranty rules order in a given security group only one instance.SecurityGroupRules is allowed per security group.
+
+        ## Example Usage
+
+        ### Basic
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        sg01 = scaleway.instance.SecurityGroup("sg01", external_rules=True)
+        sgrs01 = scaleway.instance.SecurityGroupRules("sgrs01",
+            security_group_id=sg01.id,
+            inbound_rules=[{
+                "action": "accept",
+                "port": 80,
+                "ip_range": "0.0.0.0/0",
+            }])
+        ```
+
+        ### Simplify your rules using dynamic block and `for_each` loop
+
+        You can use `for_each` syntax to simplify the definition of your rules.
+        Let's suppose that your inbound default policy is to drop, but you want to build a list of exceptions to accept.
+        Create a local containing your exceptions (`locals.trusted`) and use the `for_each` syntax in a dynamic block:
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.instance.SecurityGroup("main",
+            description="test",
+            name="terraform test",
+            inbound_default_policy="drop",
+            outbound_default_policy="accept")
+        trusted = [
+            "1.2.3.4",
+            "4.5.6.7",
+            "7.8.9.10",
+        ]
+        main_security_group_rules = scaleway.instance.SecurityGroupRules("main",
+            inbound_rules=[{
+                "action": "accept",
+                "ip": entry["value"],
+                "port": 80,
+            } for entry in [{"key": k, "value": v} for k, v in trusted]],
+            security_group_id=main.id)
+        ```
+
+        You can also use object to assign IP and port in the same time.
+        In your locals, you can use objects to encapsulate several values that will be used later on in the loop:
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.instance.SecurityGroup("main",
+            description="test",
+            name="terraform test",
+            inbound_default_policy="drop",
+            outbound_default_policy="accept")
+        trusted = [
+            {
+                "ip": "1.2.3.4",
+                "port": "80",
+            },
+            {
+                "ip": "5.6.7.8",
+                "port": "81",
+            },
+            {
+                "ip": "9.10.11.12",
+                "port": "81",
+            },
+        ]
+        main_security_group_rules = scaleway.instance.SecurityGroupRules("main",
+            inbound_rules=[{
+                "action": "accept",
+                "ip": entry["value"]["ip"],
+                "port": entry["value"]["port"],
+            } for entry in [{"key": k, "value": v} for k, v in trusted]],
+            security_group_id=main.id)
+        ```
+
+        ## Import
+
+        Instance security group rules can be imported using the `{zone}/{id}`, e.g.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:instance/securityGroupRules:SecurityGroupRules web fr-par-1/11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesInboundRuleArgs', 'SecurityGroupRulesInboundRuleArgsDict']]]] inbound_rules: A list of inbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesOutboundRuleArgs', 'SecurityGroupRulesOutboundRuleArgsDict']]]] outbound_rules: A list of outbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[str] security_group_id: The ID of the security group.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: SecurityGroupRulesArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Creates and manages Scaleway compute Instance security group rules. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-security-groups-list-security-groups).
+
+        This resource can be used to externalize rules from a `instance.SecurityGroup` to solve circular dependency problems. When using this resource do not forget to set `external_rules = true` on the security group.
+
+        > **Warning:** In order to guaranty rules order in a given security group only one instance.SecurityGroupRules is allowed per security group.
+
+        ## Example Usage
+
+        ### Basic
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        sg01 = scaleway.instance.SecurityGroup("sg01", external_rules=True)
+        sgrs01 = scaleway.instance.SecurityGroupRules("sgrs01",
+            security_group_id=sg01.id,
+            inbound_rules=[{
+                "action": "accept",
+                "port": 80,
+                "ip_range": "0.0.0.0/0",
+            }])
+        ```
+
+        ### Simplify your rules using dynamic block and `for_each` loop
+
+        You can use `for_each` syntax to simplify the definition of your rules.
+        Let's suppose that your inbound default policy is to drop, but you want to build a list of exceptions to accept.
+        Create a local containing your exceptions (`locals.trusted`) and use the `for_each` syntax in a dynamic block:
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.instance.SecurityGroup("main",
+            description="test",
+            name="terraform test",
+            inbound_default_policy="drop",
+            outbound_default_policy="accept")
+        trusted = [
+            "1.2.3.4",
+            "4.5.6.7",
+            "7.8.9.10",
+        ]
+        main_security_group_rules = scaleway.instance.SecurityGroupRules("main",
+            inbound_rules=[{
+                "action": "accept",
+                "ip": entry["value"],
+                "port": 80,
+            } for entry in [{"key": k, "value": v} for k, v in trusted]],
+            security_group_id=main.id)
+        ```
+
+        You can also use object to assign IP and port in the same time.
+        In your locals, you can use objects to encapsulate several values that will be used later on in the loop:
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.instance.SecurityGroup("main",
+            description="test",
+            name="terraform test",
+            inbound_default_policy="drop",
+            outbound_default_policy="accept")
+        trusted = [
+            {
+                "ip": "1.2.3.4",
+                "port": "80",
+            },
+            {
+                "ip": "5.6.7.8",
+                "port": "81",
+            },
+            {
+                "ip": "9.10.11.12",
+                "port": "81",
+            },
+        ]
+        main_security_group_rules = scaleway.instance.SecurityGroupRules("main",
+            inbound_rules=[{
+                "action": "accept",
+                "ip": entry["value"]["ip"],
+                "port": entry["value"]["port"],
+            } for entry in [{"key": k, "value": v} for k, v in trusted]],
+            security_group_id=main.id)
+        ```
+
+        ## Import
+
+        Instance security group rules can be imported using the `{zone}/{id}`, e.g.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:instance/securityGroupRules:SecurityGroupRules web fr-par-1/11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param SecurityGroupRulesArgs 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(SecurityGroupRulesArgs, 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,
+                 inbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesInboundRuleArgs', 'SecurityGroupRulesInboundRuleArgsDict']]]]] = None,
+                 outbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesOutboundRuleArgs', 'SecurityGroupRulesOutboundRuleArgsDict']]]]] = None,
+                 security_group_id: Optional[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__ = SecurityGroupRulesArgs.__new__(SecurityGroupRulesArgs)
+
+            __props__.__dict__["inbound_rules"] = inbound_rules
+            __props__.__dict__["outbound_rules"] = outbound_rules
+            if security_group_id is None and not opts.urn:
+                raise TypeError("Missing required property 'security_group_id'")
+            __props__.__dict__["security_group_id"] = security_group_id
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="scaleway:index/instanceSecurityGroupRules:InstanceSecurityGroupRules")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(SecurityGroupRules, __self__).__init__(
+            'scaleway:instance/securityGroupRules:SecurityGroupRules',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            inbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesInboundRuleArgs', 'SecurityGroupRulesInboundRuleArgsDict']]]]] = None,
+            outbound_rules: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesOutboundRuleArgs', 'SecurityGroupRulesOutboundRuleArgsDict']]]]] = None,
+            security_group_id: Optional[pulumi.Input[str]] = None) -> 'SecurityGroupRules':
+        """
+        Get an existing SecurityGroupRules 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[Sequence[pulumi.Input[Union['SecurityGroupRulesInboundRuleArgs', 'SecurityGroupRulesInboundRuleArgsDict']]]] inbound_rules: A list of inbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[Sequence[pulumi.Input[Union['SecurityGroupRulesOutboundRuleArgs', 'SecurityGroupRulesOutboundRuleArgsDict']]]] outbound_rules: A list of outbound rule to add to the security group. (Structure is documented below.)
+        :param pulumi.Input[str] security_group_id: The ID of the security group.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _SecurityGroupRulesState.__new__(_SecurityGroupRulesState)
+
+        __props__.__dict__["inbound_rules"] = inbound_rules
+        __props__.__dict__["outbound_rules"] = outbound_rules
+        __props__.__dict__["security_group_id"] = security_group_id
+        return SecurityGroupRules(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="inboundRules")
+    def inbound_rules(self) -> pulumi.Output[Optional[Sequence['outputs.SecurityGroupRulesInboundRule']]]:
+        """
+        A list of inbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "inbound_rules")
+
+    @property
+    @pulumi.getter(name="outboundRules")
+    def outbound_rules(self) -> pulumi.Output[Optional[Sequence['outputs.SecurityGroupRulesOutboundRule']]]:
+        """
+        A list of outbound rule to add to the security group. (Structure is documented below.)
+        """
+        return pulumi.get(self, "outbound_rules")
+
+    @property
+    @pulumi.getter(name="securityGroupId")
+    def security_group_id(self) -> pulumi.Output[str]:
+        """
+        The ID of the security group.
+        """
+        return pulumi.get(self, "security_group_id")
+