pulumi-vault 5.21.0a1710160723__py3-none-any.whl → 6.5.0a1736836139__py3-none-any.whl

pulumi_vault/get_namespace.py

@@ -0,0 +1,226 @@
+# 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
+
+__all__ = [
+    'GetNamespaceResult',
+    'AwaitableGetNamespaceResult',
+    'get_namespace',
+    'get_namespace_output',
+]
+
+@pulumi.output_type
+class GetNamespaceResult:
+    """
+    A collection of values returned by getNamespace.
+    """
+    def __init__(__self__, custom_metadata=None, id=None, namespace=None, namespace_id=None, path=None, path_fq=None):
+        if custom_metadata and not isinstance(custom_metadata, dict):
+            raise TypeError("Expected argument 'custom_metadata' to be a dict")
+        pulumi.set(__self__, "custom_metadata", custom_metadata)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if namespace and not isinstance(namespace, str):
+            raise TypeError("Expected argument 'namespace' to be a str")
+        pulumi.set(__self__, "namespace", namespace)
+        if namespace_id and not isinstance(namespace_id, str):
+            raise TypeError("Expected argument 'namespace_id' to be a str")
+        pulumi.set(__self__, "namespace_id", namespace_id)
+        if path and not isinstance(path, str):
+            raise TypeError("Expected argument 'path' to be a str")
+        pulumi.set(__self__, "path", path)
+        if path_fq and not isinstance(path_fq, str):
+            raise TypeError("Expected argument 'path_fq' to be a str")
+        pulumi.set(__self__, "path_fq", path_fq)
+
+    @property
+    @pulumi.getter(name="customMetadata")
+    def custom_metadata(self) -> Mapping[str, str]:
+        """
+        (Optional) A map of strings containing arbitrary metadata for the namespace.
+        Only fetched if `path` is specified.
+        *Requires Vault 1.12+.*
+        """
+        return pulumi.get(self, "custom_metadata")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def namespace(self) -> Optional[str]:
+        return pulumi.get(self, "namespace")
+
+    @property
+    @pulumi.getter(name="namespaceId")
+    def namespace_id(self) -> str:
+        """
+        Vault server's internal ID of the namespace.
+        Only fetched if `path` is specified.
+        """
+        return pulumi.get(self, "namespace_id")
+
+    @property
+    @pulumi.getter
+    def path(self) -> Optional[str]:
+        return pulumi.get(self, "path")
+
+    @property
+    @pulumi.getter(name="pathFq")
+    def path_fq(self) -> str:
+        """
+        The fully qualified path to the namespace. Useful when provisioning resources in a child `namespace`.
+        The path is relative to the provider's `namespace` argument.
+        """
+        return pulumi.get(self, "path_fq")
+
+
+class AwaitableGetNamespaceResult(GetNamespaceResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetNamespaceResult(
+            custom_metadata=self.custom_metadata,
+            id=self.id,
+            namespace=self.namespace,
+            namespace_id=self.namespace_id,
+            path=self.path,
+            path_fq=self.path_fq)
+
+
+def get_namespace(namespace: Optional[str] = None,
+                  path: Optional[str] = None,
+                  opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNamespaceResult:
+    """
+    ## Example Usage
+
+    ### Current namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    current = vault.get_namespace()
+    ```
+
+    ### Single namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    ns1 = vault.get_namespace(path="ns1")
+    ```
+
+    ### Nested namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    child = vault.get_namespace(namespace="parent",
+        path="child")
+    full_path = child.id
+    # -> foo/parent/child/
+    path_fq = child.path_fq
+    ```
+
+
+    :param 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#namespace).
+    :param str path: The path of the namespace. Must not have a trailing `/`.
+           If not specified or empty, path attributes are set for the current namespace
+           based on the `namespace` arguments of the provider and this data source.
+           Other path related attributes will be empty in this case.
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['path'] = path
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('vault:index/getNamespace:getNamespace', __args__, opts=opts, typ=GetNamespaceResult).value
+
+    return AwaitableGetNamespaceResult(
+        custom_metadata=pulumi.get(__ret__, 'custom_metadata'),
+        id=pulumi.get(__ret__, 'id'),
+        namespace=pulumi.get(__ret__, 'namespace'),
+        namespace_id=pulumi.get(__ret__, 'namespace_id'),
+        path=pulumi.get(__ret__, 'path'),
+        path_fq=pulumi.get(__ret__, 'path_fq'))
+def get_namespace_output(namespace: Optional[pulumi.Input[Optional[str]]] = None,
+                         path: Optional[pulumi.Input[Optional[str]]] = None,
+                         opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNamespaceResult]:
+    """
+    ## Example Usage
+
+    ### Current namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    current = vault.get_namespace()
+    ```
+
+    ### Single namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    ns1 = vault.get_namespace(path="ns1")
+    ```
+
+    ### Nested namespace
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    child = vault.get_namespace(namespace="parent",
+        path="child")
+    full_path = child.id
+    # -> foo/parent/child/
+    path_fq = child.path_fq
+    ```
+
+
+    :param 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#namespace).
+    :param str path: The path of the namespace. Must not have a trailing `/`.
+           If not specified or empty, path attributes are set for the current namespace
+           based on the `namespace` arguments of the provider and this data source.
+           Other path related attributes will be empty in this case.
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['path'] = path
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vault:index/getNamespace:getNamespace', __args__, opts=opts, typ=GetNamespaceResult)
+    return __ret__.apply(lambda __response__: GetNamespaceResult(
+        custom_metadata=pulumi.get(__response__, 'custom_metadata'),
+        id=pulumi.get(__response__, 'id'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        namespace_id=pulumi.get(__response__, 'namespace_id'),
+        path=pulumi.get(__response__, 'path'),
+        path_fq=pulumi.get(__response__, 'path_fq')))

pulumi_vault/get_namespaces.py

@@ -0,0 +1,153 @@
+# 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
+
+__all__ = [
+    'GetNamespacesResult',
+    'AwaitableGetNamespacesResult',
+    'get_namespaces',
+    'get_namespaces_output',
+]
+
+@pulumi.output_type
+class GetNamespacesResult:
+    """
+    A collection of values returned by getNamespaces.
+    """
+    def __init__(__self__, id=None, namespace=None, paths=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if namespace and not isinstance(namespace, str):
+            raise TypeError("Expected argument 'namespace' to be a str")
+        pulumi.set(__self__, "namespace", namespace)
+        if paths and not isinstance(paths, list):
+            raise TypeError("Expected argument 'paths' to be a list")
+        pulumi.set(__self__, "paths", paths)
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def namespace(self) -> Optional[str]:
+        return pulumi.get(self, "namespace")
+
+    @property
+    @pulumi.getter
+    def paths(self) -> Sequence[str]:
+        """
+        Set of the paths of direct child namespaces.
+        """
+        return pulumi.get(self, "paths")
+
+
+class AwaitableGetNamespacesResult(GetNamespacesResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetNamespacesResult(
+            id=self.id,
+            namespace=self.namespace,
+            paths=self.paths)
+
+
+def get_namespaces(namespace: Optional[str] = None,
+                   opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNamespacesResult:
+    """
+    ## Example Usage
+
+    ### Child namespaces
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    children = vault.get_namespaces()
+    ```
+
+    ### Nested namespace
+
+    To fetch the details of nested namespaces:
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    children = vault.get_namespaces(namespace="parent")
+    child = {__key: vault.get_namespace(namespace=children.namespace,
+        path=__key) for __key, __value in children.paths}
+    ```
+
+
+    :param 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#namespace).
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('vault:index/getNamespaces:getNamespaces', __args__, opts=opts, typ=GetNamespacesResult).value
+
+    return AwaitableGetNamespacesResult(
+        id=pulumi.get(__ret__, 'id'),
+        namespace=pulumi.get(__ret__, 'namespace'),
+        paths=pulumi.get(__ret__, 'paths'))
+def get_namespaces_output(namespace: Optional[pulumi.Input[Optional[str]]] = None,
+                          opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNamespacesResult]:
+    """
+    ## Example Usage
+
+    ### Child namespaces
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    children = vault.get_namespaces()
+    ```
+
+    ### Nested namespace
+
+    To fetch the details of nested namespaces:
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    children = vault.get_namespaces(namespace="parent")
+    child = {__key: vault.get_namespace(namespace=children.namespace,
+        path=__key) for __key, __value in children.paths}
+    ```
+
+
+    :param 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#namespace).
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vault:index/getNamespaces:getNamespaces', __args__, opts=opts, typ=GetNamespacesResult)
+    return __ret__.apply(lambda __response__: GetNamespacesResult(
+        id=pulumi.get(__response__, 'id'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        paths=pulumi.get(__response__, 'paths')))

pulumi_vault/get_nomad_access_token.py

@@ -4,9 +4,14 @@
 
 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
 
 __all__ = [
@@ -103,7 +108,6 @@ def get_nomad_access_token(backend: Optional[str] = None,
     """
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -120,17 +124,19 @@ def get_nomad_access_token(backend: Optional[str] = None,
         role="test",
         type="client",
         policies=["readonly"])
-    token = pulumi.Output.all(config.backend, test.role).apply(lambda backend, role: vault.get_nomad_access_token_output(backend=backend,
-        role=role))
+    token = pulumi.Output.all(
+        backend=config.backend,
+        role=test.role
+    ).apply(lambda resolved_outputs: vault.get_nomad_access_token_output(backend=resolved_outputs['backend'],
+        role=resolved_outputs['role']))
     ```
-    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the Nomad secret backend to
            read credentials from, with no leading or trailing `/`s.
     :param str namespace: The namespace of the target resource.
            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#namespace).
+           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*.
     :param str role: The name of the Nomad secret backend role to generate
            a token for, with no leading or trailing `/`s.
@@ -149,17 +155,13 @@ def get_nomad_access_token(backend: Optional[str] = None,
         namespace=pulumi.get(__ret__, 'namespace'),
         role=pulumi.get(__ret__, 'role'),
         secret_id=pulumi.get(__ret__, 'secret_id'))
-
-
-@_utilities.lift_output_func(get_nomad_access_token)
 def get_nomad_access_token_output(backend: Optional[pulumi.Input[str]] = None,
                                   namespace: Optional[pulumi.Input[Optional[str]]] = None,
                                   role: Optional[pulumi.Input[str]] = None,
-                                  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetNomadAccessTokenResult]:
+                                  opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetNomadAccessTokenResult]:
     """
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
@@ -176,19 +178,33 @@ def get_nomad_access_token_output(backend: Optional[pulumi.Input[str]] = None,
         role="test",
         type="client",
         policies=["readonly"])
-    token = pulumi.Output.all(config.backend, test.role).apply(lambda backend, role: vault.get_nomad_access_token_output(backend=backend,
-        role=role))
+    token = pulumi.Output.all(
+        backend=config.backend,
+        role=test.role
+    ).apply(lambda resolved_outputs: vault.get_nomad_access_token_output(backend=resolved_outputs['backend'],
+        role=resolved_outputs['role']))
     ```
-    <!--End PulumiCodeChooser -->
 
 
     :param str backend: The path to the Nomad secret backend to
            read credentials from, with no leading or trailing `/`s.
     :param str namespace: The namespace of the target resource.
            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#namespace).
+           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*.
     :param str role: The name of the Nomad secret backend role to generate
            a token for, with no leading or trailing `/`s.
     """
-    ...
+    __args__ = dict()
+    __args__['backend'] = backend
+    __args__['namespace'] = namespace
+    __args__['role'] = role
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vault:index/getNomadAccessToken:getNomadAccessToken', __args__, opts=opts, typ=GetNomadAccessTokenResult)
+    return __ret__.apply(lambda __response__: GetNomadAccessTokenResult(
+        accessor_id=pulumi.get(__response__, 'accessor_id'),
+        backend=pulumi.get(__response__, 'backend'),
+        id=pulumi.get(__response__, 'id'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        role=pulumi.get(__response__, 'role'),
+        secret_id=pulumi.get(__response__, 'secret_id')))

pulumi_vault/get_policy_document.py

@@ -4,9 +4,14 @@
 
 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 *
@@ -77,32 +82,32 @@ class AwaitableGetPolicyDocumentResult(GetPolicyDocumentResult):
 
 
 def get_policy_document(namespace: Optional[str] = None,
-                        rules: Optional[Sequence[pulumi.InputType['GetPolicyDocumentRuleArgs']]] = None,
+                        rules: Optional[Sequence[Union['GetPolicyDocumentRuleArgs', 'GetPolicyDocumentRuleArgsDict']]] = None,
                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPolicyDocumentResult:
     """
     This is a data source which can be used to construct a HCL representation of an Vault policy document, for use with resources which expect policy documents, such as the `Policy` resource.
 
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
 
-    example_policy_document = vault.get_policy_document(rules=[vault.GetPolicyDocumentRuleArgs(
-        path="secret/*",
-        capabilities=[
+    example = vault.get_policy_document(rules=[{
+        "path": "secret/*",
+        "capabilities": [
             "create",
             "read",
             "update",
             "delete",
             "list",
         ],
-        description="allow all on secrets",
-    )])
-    example_policy = vault.Policy("examplePolicy", policy=example_policy_document.hcl)
+        "description": "allow all on secrets",
+    }])
+    example_policy = vault.Policy("example",
+        name="example_policy",
+        policy=example.hcl)
     ```
-    <!--End PulumiCodeChooser -->
     """
     __args__ = dict()
     __args__['namespace'] = namespace
@@ -115,35 +120,41 @@ def get_policy_document(namespace: Optional[str] = None,
         id=pulumi.get(__ret__, 'id'),
         namespace=pulumi.get(__ret__, 'namespace'),
         rules=pulumi.get(__ret__, 'rules'))
-
-
-@_utilities.lift_output_func(get_policy_document)
 def get_policy_document_output(namespace: Optional[pulumi.Input[Optional[str]]] = None,
-                               rules: Optional[pulumi.Input[Optional[Sequence[pulumi.InputType['GetPolicyDocumentRuleArgs']]]]] = None,
-                               opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetPolicyDocumentResult]:
+                               rules: Optional[pulumi.Input[Optional[Sequence[Union['GetPolicyDocumentRuleArgs', 'GetPolicyDocumentRuleArgsDict']]]]] = None,
+                               opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetPolicyDocumentResult]:
     """
     This is a data source which can be used to construct a HCL representation of an Vault policy document, for use with resources which expect policy documents, such as the `Policy` resource.
 
     ## Example Usage
 
-    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vault as vault
 
-    example_policy_document = vault.get_policy_document(rules=[vault.GetPolicyDocumentRuleArgs(
-        path="secret/*",
-        capabilities=[
+    example = vault.get_policy_document(rules=[{
+        "path": "secret/*",
+        "capabilities": [
             "create",
             "read",
             "update",
             "delete",
             "list",
         ],
-        description="allow all on secrets",
-    )])
-    example_policy = vault.Policy("examplePolicy", policy=example_policy_document.hcl)
+        "description": "allow all on secrets",
+    }])
+    example_policy = vault.Policy("example",
+        name="example_policy",
+        policy=example.hcl)
     ```
-    <!--End PulumiCodeChooser -->
     """
-    ...
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['rules'] = rules
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vault:index/getPolicyDocument:getPolicyDocument', __args__, opts=opts, typ=GetPolicyDocumentResult)
+    return __ret__.apply(lambda __response__: GetPolicyDocumentResult(
+        hcl=pulumi.get(__response__, 'hcl'),
+        id=pulumi.get(__response__, 'id'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        rules=pulumi.get(__response__, 'rules')))