pulumi-vault 7.6.0a1764657486__py3-none-any.whl

pulumi_vault/get_auth_backend.py

@@ -0,0 +1,226 @@
+# 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__ = [
+    'GetAuthBackendResult',
+    'AwaitableGetAuthBackendResult',
+    'get_auth_backend',
+    'get_auth_backend_output',
+]
+
+@pulumi.output_type
+class GetAuthBackendResult:
+    """
+    A collection of values returned by getAuthBackend.
+    """
+    def __init__(__self__, accessor=None, default_lease_ttl_seconds=None, description=None, id=None, listing_visibility=None, local=None, max_lease_ttl_seconds=None, namespace=None, path=None, type=None):
+        if accessor and not isinstance(accessor, str):
+            raise TypeError("Expected argument 'accessor' to be a str")
+        pulumi.set(__self__, "accessor", accessor)
+        if default_lease_ttl_seconds and not isinstance(default_lease_ttl_seconds, int):
+            raise TypeError("Expected argument 'default_lease_ttl_seconds' to be a int")
+        pulumi.set(__self__, "default_lease_ttl_seconds", default_lease_ttl_seconds)
+        if description and not isinstance(description, str):
+            raise TypeError("Expected argument 'description' to be a str")
+        pulumi.set(__self__, "description", description)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if listing_visibility and not isinstance(listing_visibility, str):
+            raise TypeError("Expected argument 'listing_visibility' to be a str")
+        pulumi.set(__self__, "listing_visibility", listing_visibility)
+        if local and not isinstance(local, bool):
+            raise TypeError("Expected argument 'local' to be a bool")
+        pulumi.set(__self__, "local", local)
+        if max_lease_ttl_seconds and not isinstance(max_lease_ttl_seconds, int):
+            raise TypeError("Expected argument 'max_lease_ttl_seconds' to be a int")
+        pulumi.set(__self__, "max_lease_ttl_seconds", max_lease_ttl_seconds)
+        if namespace and not isinstance(namespace, str):
+            raise TypeError("Expected argument 'namespace' to be a str")
+        pulumi.set(__self__, "namespace", namespace)
+        if path and not isinstance(path, str):
+            raise TypeError("Expected argument 'path' to be a str")
+        pulumi.set(__self__, "path", path)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @_builtins.property
+    @pulumi.getter
+    def accessor(self) -> _builtins.str:
+        """
+        The accessor for this auth method.
+        """
+        return pulumi.get(self, "accessor")
+
+    @_builtins.property
+    @pulumi.getter(name="defaultLeaseTtlSeconds")
+    def default_lease_ttl_seconds(self) -> _builtins.int:
+        """
+        The default lease duration in seconds.
+        """
+        return pulumi.get(self, "default_lease_ttl_seconds")
+
+    @_builtins.property
+    @pulumi.getter
+    def description(self) -> _builtins.str:
+        """
+        A description of the auth method.
+        """
+        return pulumi.get(self, "description")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="listingVisibility")
+    def listing_visibility(self) -> _builtins.str:
+        """
+        Specifies whether to show this mount in the UI-specific listing endpoint.
+        """
+        return pulumi.get(self, "listing_visibility")
+
+    @_builtins.property
+    @pulumi.getter
+    def local(self) -> _builtins.bool:
+        """
+        Specifies if the auth method is local only.
+        """
+        return pulumi.get(self, "local")
+
+    @_builtins.property
+    @pulumi.getter(name="maxLeaseTtlSeconds")
+    def max_lease_ttl_seconds(self) -> _builtins.int:
+        """
+        The maximum lease duration in seconds.
+        """
+        return pulumi.get(self, "max_lease_ttl_seconds")
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "namespace")
+
+    @_builtins.property
+    @pulumi.getter
+    def path(self) -> _builtins.str:
+        return pulumi.get(self, "path")
+
+    @_builtins.property
+    @pulumi.getter
+    def type(self) -> _builtins.str:
+        """
+        The name of the auth method type.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetAuthBackendResult(GetAuthBackendResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAuthBackendResult(
+            accessor=self.accessor,
+            default_lease_ttl_seconds=self.default_lease_ttl_seconds,
+            description=self.description,
+            id=self.id,
+            listing_visibility=self.listing_visibility,
+            local=self.local,
+            max_lease_ttl_seconds=self.max_lease_ttl_seconds,
+            namespace=self.namespace,
+            path=self.path,
+            type=self.type)
+
+
+def get_auth_backend(namespace: Optional[_builtins.str] = None,
+                     path: Optional[_builtins.str] = None,
+                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAuthBackendResult:
+    """
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example = vault.get_auth_backend(path="userpass")
+    ```
+
+
+    :param _builtins.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/index.html#namespace).
+           *Available only for Vault Enterprise*.
+    :param _builtins.str path: The auth backend mount point.
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['path'] = path
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('vault:index/getAuthBackend:getAuthBackend', __args__, opts=opts, typ=GetAuthBackendResult).value
+
+    return AwaitableGetAuthBackendResult(
+        accessor=pulumi.get(__ret__, 'accessor'),
+        default_lease_ttl_seconds=pulumi.get(__ret__, 'default_lease_ttl_seconds'),
+        description=pulumi.get(__ret__, 'description'),
+        id=pulumi.get(__ret__, 'id'),
+        listing_visibility=pulumi.get(__ret__, 'listing_visibility'),
+        local=pulumi.get(__ret__, 'local'),
+        max_lease_ttl_seconds=pulumi.get(__ret__, 'max_lease_ttl_seconds'),
+        namespace=pulumi.get(__ret__, 'namespace'),
+        path=pulumi.get(__ret__, 'path'),
+        type=pulumi.get(__ret__, 'type'))
+def get_auth_backend_output(namespace: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                            path: Optional[pulumi.Input[_builtins.str]] = None,
+                            opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAuthBackendResult]:
+    """
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example = vault.get_auth_backend(path="userpass")
+    ```
+
+
+    :param _builtins.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/index.html#namespace).
+           *Available only for Vault Enterprise*.
+    :param _builtins.str path: The auth backend mount point.
+    """
+    __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/getAuthBackend:getAuthBackend', __args__, opts=opts, typ=GetAuthBackendResult)
+    return __ret__.apply(lambda __response__: GetAuthBackendResult(
+        accessor=pulumi.get(__response__, 'accessor'),
+        default_lease_ttl_seconds=pulumi.get(__response__, 'default_lease_ttl_seconds'),
+        description=pulumi.get(__response__, 'description'),
+        id=pulumi.get(__response__, 'id'),
+        listing_visibility=pulumi.get(__response__, 'listing_visibility'),
+        local=pulumi.get(__response__, 'local'),
+        max_lease_ttl_seconds=pulumi.get(__response__, 'max_lease_ttl_seconds'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        path=pulumi.get(__response__, 'path'),
+        type=pulumi.get(__response__, 'type')))

pulumi_vault/get_auth_backends.py

@@ -0,0 +1,170 @@
+# 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__ = [
+    'GetAuthBackendsResult',
+    'AwaitableGetAuthBackendsResult',
+    'get_auth_backends',
+    'get_auth_backends_output',
+]
+
+@pulumi.output_type
+class GetAuthBackendsResult:
+    """
+    A collection of values returned by getAuthBackends.
+    """
+    def __init__(__self__, accessors=None, id=None, namespace=None, paths=None, type=None):
+        if accessors and not isinstance(accessors, list):
+            raise TypeError("Expected argument 'accessors' to be a list")
+        pulumi.set(__self__, "accessors", accessors)
+        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)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @_builtins.property
+    @pulumi.getter
+    def accessors(self) -> Sequence[_builtins.str]:
+        """
+        The accessor IDs for the auth methods.
+        """
+        return pulumi.get(self, "accessors")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "namespace")
+
+    @_builtins.property
+    @pulumi.getter
+    def paths(self) -> Sequence[_builtins.str]:
+        """
+        List of auth backend mount points.
+        """
+        return pulumi.get(self, "paths")
+
+    @_builtins.property
+    @pulumi.getter
+    def type(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetAuthBackendsResult(GetAuthBackendsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAuthBackendsResult(
+            accessors=self.accessors,
+            id=self.id,
+            namespace=self.namespace,
+            paths=self.paths,
+            type=self.type)
+
+
+def get_auth_backends(namespace: Optional[_builtins.str] = None,
+                      type: Optional[_builtins.str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAuthBackendsResult:
+    """
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example = vault.get_auth_backends()
+    ```
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example_filter = vault.get_auth_backends(type="kubernetes")
+    ```
+
+
+    :param _builtins.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/index.html#namespace).
+           *Available only for Vault Enterprise*.
+    :param _builtins.str type: The name of the auth method type. Allows filtering of backends returned by type.
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['type'] = type
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('vault:index/getAuthBackends:getAuthBackends', __args__, opts=opts, typ=GetAuthBackendsResult).value
+
+    return AwaitableGetAuthBackendsResult(
+        accessors=pulumi.get(__ret__, 'accessors'),
+        id=pulumi.get(__ret__, 'id'),
+        namespace=pulumi.get(__ret__, 'namespace'),
+        paths=pulumi.get(__ret__, 'paths'),
+        type=pulumi.get(__ret__, 'type'))
+def get_auth_backends_output(namespace: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                             type: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAuthBackendsResult]:
+    """
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example = vault.get_auth_backends()
+    ```
+
+    ```python
+    import pulumi
+    import pulumi_vault as vault
+
+    example_filter = vault.get_auth_backends(type="kubernetes")
+    ```
+
+
+    :param _builtins.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/index.html#namespace).
+           *Available only for Vault Enterprise*.
+    :param _builtins.str type: The name of the auth method type. Allows filtering of backends returned by type.
+    """
+    __args__ = dict()
+    __args__['namespace'] = namespace
+    __args__['type'] = type
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vault:index/getAuthBackends:getAuthBackends', __args__, opts=opts, typ=GetAuthBackendsResult)
+    return __ret__.apply(lambda __response__: GetAuthBackendsResult(
+        accessors=pulumi.get(__response__, 'accessors'),
+        id=pulumi.get(__response__, 'id'),
+        namespace=pulumi.get(__response__, 'namespace'),
+        paths=pulumi.get(__response__, 'paths'),
+        type=pulumi.get(__response__, 'type')))

pulumi_vault/get_namespace.py

@@ -0,0 +1,226 @@
+# 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__ = [
+    '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)
+
+    @_builtins.property
+    @pulumi.getter(name="customMetadata")
+    def custom_metadata(self) -> Mapping[str, _builtins.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")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def namespace(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "namespace")
+
+    @_builtins.property
+    @pulumi.getter(name="namespaceId")
+    def namespace_id(self) -> _builtins.str:
+        """
+        Vault server's internal ID of the namespace.
+        Only fetched if `path` is specified.
+        """
+        return pulumi.get(self, "namespace_id")
+
+    @_builtins.property
+    @pulumi.getter
+    def path(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "path")
+
+    @_builtins.property
+    @pulumi.getter(name="pathFq")
+    def path_fq(self) -> _builtins.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[_builtins.str] = None,
+                  path: Optional[_builtins.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 _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#namespace).
+    :param _builtins.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[_builtins.str]]] = None,
+                         path: Optional[pulumi.Input[Optional[_builtins.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 _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#namespace).
+    :param _builtins.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')))