pulumi-confluentcloud 2.13.0a1735836869__py3-none-any.whl → 2.50.0a1762926155__py3-none-any.whl

pulumi_confluentcloud/ip_group.py

@@ -0,0 +1,264 @@
+# 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
+
+__all__ = ['IpGroupArgs', 'IpGroup']
+
+@pulumi.input_type
+class IpGroupArgs:
+    def __init__(__self__, *,
+                 cidr_blocks: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]],
+                 group_name: pulumi.Input[_builtins.str]):
+        """
+        The set of arguments for constructing a IpGroup resource.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] cidr_blocks: A list of CIDRs.
+        :param pulumi.Input[_builtins.str] group_name: A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        pulumi.set(__self__, "cidr_blocks", cidr_blocks)
+        pulumi.set(__self__, "group_name", group_name)
+
+    @_builtins.property
+    @pulumi.getter(name="cidrBlocks")
+    def cidr_blocks(self) -> pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]:
+        """
+        A list of CIDRs.
+        """
+        return pulumi.get(self, "cidr_blocks")
+
+    @cidr_blocks.setter
+    def cidr_blocks(self, value: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
+        pulumi.set(self, "cidr_blocks", value)
+
+    @_builtins.property
+    @pulumi.getter(name="groupName")
+    def group_name(self) -> pulumi.Input[_builtins.str]:
+        """
+        A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        return pulumi.get(self, "group_name")
+
+    @group_name.setter
+    def group_name(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "group_name", value)
+
+
+@pulumi.input_type
+class _IpGroupState:
+    def __init__(__self__, *,
+                 cidr_blocks: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 group_name: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering IpGroup resources.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] cidr_blocks: A list of CIDRs.
+        :param pulumi.Input[_builtins.str] group_name: A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        if cidr_blocks is not None:
+            pulumi.set(__self__, "cidr_blocks", cidr_blocks)
+        if group_name is not None:
+            pulumi.set(__self__, "group_name", group_name)
+
+    @_builtins.property
+    @pulumi.getter(name="cidrBlocks")
+    def cidr_blocks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        A list of CIDRs.
+        """
+        return pulumi.get(self, "cidr_blocks")
+
+    @cidr_blocks.setter
+    def cidr_blocks(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "cidr_blocks", value)
+
+    @_builtins.property
+    @pulumi.getter(name="groupName")
+    def group_name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        return pulumi.get(self, "group_name")
+
+    @group_name.setter
+    def group_name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "group_name", value)
+
+
+@pulumi.type_token("confluentcloud:index/ipGroup:IpGroup")
+class IpGroup(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 cidr_blocks: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 group_name: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
+
+        `IpGroup` provides an IP Group resource that enables creating, editing, and deleting IP Groups on Confluent Cloud.
+
+        > **Note:** See [IP Filtering on Confluent Cloud](https://docs.confluent.io/cloud/current/security/access-control/ip-filtering/overview.html) for more details about the IP Filtering feature, its prerequisites, and its limitations.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_confluentcloud as confluentcloud
+
+        example = confluentcloud.IpGroup("example",
+            group_name="CorpNet",
+            cidr_blocks=[
+                "192.168.0.0/24",
+                "192.168.7.0/24",
+            ])
+        ```
+
+        ## Import
+
+        You can import an IP Group by using IP Group ID, for example:
+
+        $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
+
+        $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
+
+        ```sh
+        $ pulumi import confluentcloud:index/ipGroup:IpGroup example ipg-abc123
+        ```
+
+        !> **Warning:** Do not forget to delete terminal command history afterwards for security purposes.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] cidr_blocks: A list of CIDRs.
+        :param pulumi.Input[_builtins.str] group_name: A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: IpGroupArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
+
+        `IpGroup` provides an IP Group resource that enables creating, editing, and deleting IP Groups on Confluent Cloud.
+
+        > **Note:** See [IP Filtering on Confluent Cloud](https://docs.confluent.io/cloud/current/security/access-control/ip-filtering/overview.html) for more details about the IP Filtering feature, its prerequisites, and its limitations.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_confluentcloud as confluentcloud
+
+        example = confluentcloud.IpGroup("example",
+            group_name="CorpNet",
+            cidr_blocks=[
+                "192.168.0.0/24",
+                "192.168.7.0/24",
+            ])
+        ```
+
+        ## Import
+
+        You can import an IP Group by using IP Group ID, for example:
+
+        $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
+
+        $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
+
+        ```sh
+        $ pulumi import confluentcloud:index/ipGroup:IpGroup example ipg-abc123
+        ```
+
+        !> **Warning:** Do not forget to delete terminal command history afterwards for security purposes.
+
+        :param str resource_name: The name of the resource.
+        :param IpGroupArgs 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(IpGroupArgs, 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,
+                 cidr_blocks: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 group_name: 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__ = IpGroupArgs.__new__(IpGroupArgs)
+
+            if cidr_blocks is None and not opts.urn:
+                raise TypeError("Missing required property 'cidr_blocks'")
+            __props__.__dict__["cidr_blocks"] = cidr_blocks
+            if group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'group_name'")
+            __props__.__dict__["group_name"] = group_name
+        super(IpGroup, __self__).__init__(
+            'confluentcloud:index/ipGroup:IpGroup',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            cidr_blocks: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+            group_name: Optional[pulumi.Input[_builtins.str]] = None) -> 'IpGroup':
+        """
+        Get an existing IpGroup 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[_builtins.str]]] cidr_blocks: A list of CIDRs.
+        :param pulumi.Input[_builtins.str] group_name: A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _IpGroupState.__new__(_IpGroupState)
+
+        __props__.__dict__["cidr_blocks"] = cidr_blocks
+        __props__.__dict__["group_name"] = group_name
+        return IpGroup(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter(name="cidrBlocks")
+    def cidr_blocks(self) -> pulumi.Output[Sequence[_builtins.str]]:
+        """
+        A list of CIDRs.
+        """
+        return pulumi.get(self, "cidr_blocks")
+
+    @_builtins.property
+    @pulumi.getter(name="groupName")
+    def group_name(self) -> pulumi.Output[_builtins.str]:
+        """
+        A human-readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
+        """
+        return pulumi.get(self, "group_name")
+