pulumi-vault 7.6.0a1764657486__py3-none-any.whl

pulumi_vault/identity/group_member_group_ids.py

@@ -0,0 +1,467 @@
+# 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__ = ['GroupMemberGroupIdsArgs', 'GroupMemberGroupIds']
+
+@pulumi.input_type
+class GroupMemberGroupIdsArgs:
+    def __init__(__self__, *,
+                 group_id: pulumi.Input[_builtins.str],
+                 exclusive: Optional[pulumi.Input[_builtins.bool]] = None,
+                 member_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        The set of arguments for constructing a GroupMemberGroupIds resource.
+        :param pulumi.Input[_builtins.str] group_id: Group ID to assign member entities to.
+        :param pulumi.Input[_builtins.bool] exclusive: Defaults to `true`.
+               
+               If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+               it equal to what is specified in the resource.
+               
+               If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+               in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+               are removed.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] member_group_ids: List of member groups that belong to the group
+        :param pulumi.Input[_builtins.str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+               *Available only for Vault Enterprise*.
+        """
+        pulumi.set(__self__, "group_id", group_id)
+        if exclusive is not None:
+            pulumi.set(__self__, "exclusive", exclusive)
+        if member_group_ids is not None:
+            pulumi.set(__self__, "member_group_ids", member_group_ids)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+
+    @_builtins.property
+    @pulumi.getter(name="groupId")
+    def group_id(self) -> pulumi.Input[_builtins.str]:
+        """
+        Group ID to assign member entities to.
+        """
+        return pulumi.get(self, "group_id")
+
+    @group_id.setter
+    def group_id(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "group_id", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def exclusive(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Defaults to `true`.
+
+        If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+        it equal to what is specified in the resource.
+
+        If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+        in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+        are removed.
+        """
+        return pulumi.get(self, "exclusive")
+
+    @exclusive.setter
+    def exclusive(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "exclusive", value)
+
+    @_builtins.property
+    @pulumi.getter(name="memberGroupIds")
+    def member_group_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        List of member groups that belong to the group
+        """
+        return pulumi.get(self, "member_group_ids")
+
+    @member_group_ids.setter
+    def member_group_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "member_group_ids", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+        *Available only for Vault Enterprise*.
+        """
+        return pulumi.get(self, "namespace")
+
+    @namespace.setter
+    def namespace(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "namespace", value)
+
+
+@pulumi.input_type
+class _GroupMemberGroupIdsState:
+    def __init__(__self__, *,
+                 exclusive: Optional[pulumi.Input[_builtins.bool]] = None,
+                 group_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 member_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering GroupMemberGroupIds resources.
+        :param pulumi.Input[_builtins.bool] exclusive: Defaults to `true`.
+               
+               If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+               it equal to what is specified in the resource.
+               
+               If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+               in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+               are removed.
+        :param pulumi.Input[_builtins.str] group_id: Group ID to assign member entities to.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] member_group_ids: List of member groups that belong to the group
+        :param pulumi.Input[_builtins.str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+               *Available only for Vault Enterprise*.
+        """
+        if exclusive is not None:
+            pulumi.set(__self__, "exclusive", exclusive)
+        if group_id is not None:
+            pulumi.set(__self__, "group_id", group_id)
+        if member_group_ids is not None:
+            pulumi.set(__self__, "member_group_ids", member_group_ids)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+
+    @_builtins.property
+    @pulumi.getter
+    def exclusive(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Defaults to `true`.
+
+        If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+        it equal to what is specified in the resource.
+
+        If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+        in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+        are removed.
+        """
+        return pulumi.get(self, "exclusive")
+
+    @exclusive.setter
+    def exclusive(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "exclusive", value)
+
+    @_builtins.property
+    @pulumi.getter(name="groupId")
+    def group_id(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        Group ID to assign member entities to.
+        """
+        return pulumi.get(self, "group_id")
+
+    @group_id.setter
+    def group_id(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "group_id", value)
+
+    @_builtins.property
+    @pulumi.getter(name="memberGroupIds")
+    def member_group_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        List of member groups that belong to the group
+        """
+        return pulumi.get(self, "member_group_ids")
+
+    @member_group_ids.setter
+    def member_group_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "member_group_ids", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+        *Available only for Vault Enterprise*.
+        """
+        return pulumi.get(self, "namespace")
+
+    @namespace.setter
+    def namespace(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "namespace", value)
+
+
+@pulumi.type_token("vault:identity/groupMemberGroupIds:GroupMemberGroupIds")
+class GroupMemberGroupIds(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 exclusive: Optional[pulumi.Input[_builtins.bool]] = None,
+                 group_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 member_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 __props__=None):
+        """
+        Manages member groups for an Identity Group for Vault. The
+        [Identity secrets engine](https://www.vaultproject.io/docs/secrets/identity/index.html)
+        is the identity management solution for Vault.
+
+        ## Example Usage
+
+        ### Exclusive Member Groups
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        internal = vault.identity.Group("internal",
+            name="internal",
+            type="internal",
+            external_member_group_ids=True,
+            metadata={
+                "version": "2",
+            })
+        users = vault.identity.Group("users",
+            name="users",
+            metadata={
+                "version": "2",
+            })
+        members = vault.identity.GroupMemberGroupIds("members",
+            exclusive=True,
+            member_group_ids=[users.id],
+            group_id=internal.id)
+        ```
+
+        ### Non-Exclusive Member Groups
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        internal = vault.identity.Group("internal",
+            name="internal",
+            type="internal",
+            external_member_group_ids=True,
+            metadata={
+                "version": "2",
+            })
+        users = vault.identity.Group("users",
+            name="users",
+            metadata={
+                "version": "2",
+            })
+        members = vault.identity.GroupMemberGroupIds("members",
+            exclusive=False,
+            member_group_ids=[users.id],
+            group_id=internal.id)
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.bool] exclusive: Defaults to `true`.
+               
+               If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+               it equal to what is specified in the resource.
+               
+               If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+               in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+               are removed.
+        :param pulumi.Input[_builtins.str] group_id: Group ID to assign member entities to.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] member_group_ids: List of member groups that belong to the group
+        :param pulumi.Input[_builtins.str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+               *Available only for Vault Enterprise*.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: GroupMemberGroupIdsArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        Manages member groups for an Identity Group for Vault. The
+        [Identity secrets engine](https://www.vaultproject.io/docs/secrets/identity/index.html)
+        is the identity management solution for Vault.
+
+        ## Example Usage
+
+        ### Exclusive Member Groups
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        internal = vault.identity.Group("internal",
+            name="internal",
+            type="internal",
+            external_member_group_ids=True,
+            metadata={
+                "version": "2",
+            })
+        users = vault.identity.Group("users",
+            name="users",
+            metadata={
+                "version": "2",
+            })
+        members = vault.identity.GroupMemberGroupIds("members",
+            exclusive=True,
+            member_group_ids=[users.id],
+            group_id=internal.id)
+        ```
+
+        ### Non-Exclusive Member Groups
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        internal = vault.identity.Group("internal",
+            name="internal",
+            type="internal",
+            external_member_group_ids=True,
+            metadata={
+                "version": "2",
+            })
+        users = vault.identity.Group("users",
+            name="users",
+            metadata={
+                "version": "2",
+            })
+        members = vault.identity.GroupMemberGroupIds("members",
+            exclusive=False,
+            member_group_ids=[users.id],
+            group_id=internal.id)
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param GroupMemberGroupIdsArgs 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(GroupMemberGroupIdsArgs, 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,
+                 exclusive: Optional[pulumi.Input[_builtins.bool]] = None,
+                 group_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 member_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 namespace: 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__ = GroupMemberGroupIdsArgs.__new__(GroupMemberGroupIdsArgs)
+
+            __props__.__dict__["exclusive"] = exclusive
+            if group_id is None and not opts.urn:
+                raise TypeError("Missing required property 'group_id'")
+            __props__.__dict__["group_id"] = group_id
+            __props__.__dict__["member_group_ids"] = member_group_ids
+            __props__.__dict__["namespace"] = namespace
+        super(GroupMemberGroupIds, __self__).__init__(
+            'vault:identity/groupMemberGroupIds:GroupMemberGroupIds',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            exclusive: Optional[pulumi.Input[_builtins.bool]] = None,
+            group_id: Optional[pulumi.Input[_builtins.str]] = None,
+            member_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+            namespace: Optional[pulumi.Input[_builtins.str]] = None) -> 'GroupMemberGroupIds':
+        """
+        Get an existing GroupMemberGroupIds 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.bool] exclusive: Defaults to `true`.
+               
+               If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+               it equal to what is specified in the resource.
+               
+               If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+               in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+               are removed.
+        :param pulumi.Input[_builtins.str] group_id: Group ID to assign member entities to.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] member_group_ids: List of member groups that belong to the group
+        :param pulumi.Input[_builtins.str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+               *Available only for Vault Enterprise*.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _GroupMemberGroupIdsState.__new__(_GroupMemberGroupIdsState)
+
+        __props__.__dict__["exclusive"] = exclusive
+        __props__.__dict__["group_id"] = group_id
+        __props__.__dict__["member_group_ids"] = member_group_ids
+        __props__.__dict__["namespace"] = namespace
+        return GroupMemberGroupIds(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter
+    def exclusive(self) -> pulumi.Output[Optional[_builtins.bool]]:
+        """
+        Defaults to `true`.
+
+        If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
+        it equal to what is specified in the resource.
+
+        If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
+        in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
+        are removed.
+        """
+        return pulumi.get(self, "exclusive")
+
+    @_builtins.property
+    @pulumi.getter(name="groupId")
+    def group_id(self) -> pulumi.Output[_builtins.str]:
+        """
+        Group ID to assign member entities to.
+        """
+        return pulumi.get(self, "group_id")
+
+    @_builtins.property
+    @pulumi.getter(name="memberGroupIds")
+    def member_group_ids(self) -> pulumi.Output[Optional[Sequence[_builtins.str]]]:
+        """
+        List of member groups that belong to the group
+        """
+        return pulumi.get(self, "member_group_ids")
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
+        *Available only for Vault Enterprise*.
+        """
+        return pulumi.get(self, "namespace")
+