pulumi-vault 7.6.0a1764657486__py3-none-any.whl

pulumi_vault/ad/secret_library.py

@@ -0,0 +1,546 @@
+# 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__ = ['SecretLibraryArgs', 'SecretLibrary']
+
+@pulumi.input_type
+class SecretLibraryArgs:
+    def __init__(__self__, *,
+                 backend: pulumi.Input[_builtins.str],
+                 service_account_names: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]],
+                 disable_check_in_enforcement: Optional[pulumi.Input[_builtins.bool]] = None,
+                 max_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 ttl: Optional[pulumi.Input[_builtins.int]] = None):
+        """
+        The set of arguments for constructing a SecretLibrary resource.
+        :param pulumi.Input[_builtins.str] backend: The path the AD secret backend is mounted at,
+               with no leading or trailing `/`s.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] service_account_names: Specifies the slice of service accounts mapped to this set.
+        :param pulumi.Input[_builtins.bool] disable_check_in_enforcement: Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        :param pulumi.Input[_builtins.int] max_ttl: The maximum password time-to-live in seconds. Defaults to the configuration
+               max_ttl if not provided.
+        :param pulumi.Input[_builtins.str] name: The name to identify this set of service accounts.
+               Must be unique within the backend.
+        :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*.
+        :param pulumi.Input[_builtins.int] ttl: The password time-to-live in seconds. Defaults to the configuration
+               ttl if not provided.
+        """
+        pulumi.set(__self__, "backend", backend)
+        pulumi.set(__self__, "service_account_names", service_account_names)
+        if disable_check_in_enforcement is not None:
+            pulumi.set(__self__, "disable_check_in_enforcement", disable_check_in_enforcement)
+        if max_ttl is not None:
+            pulumi.set(__self__, "max_ttl", max_ttl)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if ttl is not None:
+            pulumi.set(__self__, "ttl", ttl)
+
+    @_builtins.property
+    @pulumi.getter
+    def backend(self) -> pulumi.Input[_builtins.str]:
+        """
+        The path the AD secret backend is mounted at,
+        with no leading or trailing `/`s.
+        """
+        return pulumi.get(self, "backend")
+
+    @backend.setter
+    def backend(self, value: pulumi.Input[_builtins.str]):
+        pulumi.set(self, "backend", value)
+
+    @_builtins.property
+    @pulumi.getter(name="serviceAccountNames")
+    def service_account_names(self) -> pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]:
+        """
+        Specifies the slice of service accounts mapped to this set.
+        """
+        return pulumi.get(self, "service_account_names")
+
+    @service_account_names.setter
+    def service_account_names(self, value: pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]):
+        pulumi.set(self, "service_account_names", value)
+
+    @_builtins.property
+    @pulumi.getter(name="disableCheckInEnforcement")
+    def disable_check_in_enforcement(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        """
+        return pulumi.get(self, "disable_check_in_enforcement")
+
+    @disable_check_in_enforcement.setter
+    def disable_check_in_enforcement(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "disable_check_in_enforcement", value)
+
+    @_builtins.property
+    @pulumi.getter(name="maxTtl")
+    def max_ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The maximum password time-to-live in seconds. Defaults to the configuration
+        max_ttl if not provided.
+        """
+        return pulumi.get(self, "max_ttl")
+
+    @max_ttl.setter
+    def max_ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "max_ttl", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The name to identify this set of service accounts.
+        Must be unique within the backend.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "name", 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)
+
+    @_builtins.property
+    @pulumi.getter
+    def ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The password time-to-live in seconds. Defaults to the configuration
+        ttl if not provided.
+        """
+        return pulumi.get(self, "ttl")
+
+    @ttl.setter
+    def ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "ttl", value)
+
+
+@pulumi.input_type
+class _SecretLibraryState:
+    def __init__(__self__, *,
+                 backend: Optional[pulumi.Input[_builtins.str]] = None,
+                 disable_check_in_enforcement: Optional[pulumi.Input[_builtins.bool]] = None,
+                 max_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 service_account_names: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 ttl: Optional[pulumi.Input[_builtins.int]] = None):
+        """
+        Input properties used for looking up and filtering SecretLibrary resources.
+        :param pulumi.Input[_builtins.str] backend: The path the AD secret backend is mounted at,
+               with no leading or trailing `/`s.
+        :param pulumi.Input[_builtins.bool] disable_check_in_enforcement: Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        :param pulumi.Input[_builtins.int] max_ttl: The maximum password time-to-live in seconds. Defaults to the configuration
+               max_ttl if not provided.
+        :param pulumi.Input[_builtins.str] name: The name to identify this set of service accounts.
+               Must be unique within the backend.
+        :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*.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] service_account_names: Specifies the slice of service accounts mapped to this set.
+        :param pulumi.Input[_builtins.int] ttl: The password time-to-live in seconds. Defaults to the configuration
+               ttl if not provided.
+        """
+        if backend is not None:
+            pulumi.set(__self__, "backend", backend)
+        if disable_check_in_enforcement is not None:
+            pulumi.set(__self__, "disable_check_in_enforcement", disable_check_in_enforcement)
+        if max_ttl is not None:
+            pulumi.set(__self__, "max_ttl", max_ttl)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if service_account_names is not None:
+            pulumi.set(__self__, "service_account_names", service_account_names)
+        if ttl is not None:
+            pulumi.set(__self__, "ttl", ttl)
+
+    @_builtins.property
+    @pulumi.getter
+    def backend(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The path the AD secret backend is mounted at,
+        with no leading or trailing `/`s.
+        """
+        return pulumi.get(self, "backend")
+
+    @backend.setter
+    def backend(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "backend", value)
+
+    @_builtins.property
+    @pulumi.getter(name="disableCheckInEnforcement")
+    def disable_check_in_enforcement(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        """
+        return pulumi.get(self, "disable_check_in_enforcement")
+
+    @disable_check_in_enforcement.setter
+    def disable_check_in_enforcement(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "disable_check_in_enforcement", value)
+
+    @_builtins.property
+    @pulumi.getter(name="maxTtl")
+    def max_ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The maximum password time-to-live in seconds. Defaults to the configuration
+        max_ttl if not provided.
+        """
+        return pulumi.get(self, "max_ttl")
+
+    @max_ttl.setter
+    def max_ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "max_ttl", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        The name to identify this set of service accounts.
+        Must be unique within the backend.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "name", 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)
+
+    @_builtins.property
+    @pulumi.getter(name="serviceAccountNames")
+    def service_account_names(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        Specifies the slice of service accounts mapped to this set.
+        """
+        return pulumi.get(self, "service_account_names")
+
+    @service_account_names.setter
+    def service_account_names(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "service_account_names", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        The password time-to-live in seconds. Defaults to the configuration
+        ttl if not provided.
+        """
+        return pulumi.get(self, "ttl")
+
+    @ttl.setter
+    def ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "ttl", value)
+
+
+@pulumi.type_token("vault:ad/secretLibrary:SecretLibrary")
+class SecretLibrary(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 backend: Optional[pulumi.Input[_builtins.str]] = None,
+                 disable_check_in_enforcement: Optional[pulumi.Input[_builtins.bool]] = None,
+                 max_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 service_account_names: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 __props__=None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        config = vault.ad.SecretBackend("config",
+            backend="ad",
+            binddn="CN=Administrator,CN=Users,DC=corp,DC=example,DC=net",
+            bindpass="SuperSecretPassw0rd",
+            url="ldaps://ad",
+            insecure_tls=True,
+            userdn="CN=Users,DC=corp,DC=example,DC=net")
+        qa = vault.ad.SecretLibrary("qa",
+            backend=config.backend,
+            name="qa",
+            service_account_names=[
+                "Bob",
+                "Mary",
+            ],
+            ttl=60,
+            disable_check_in_enforcement=True,
+            max_ttl=120)
+        ```
+
+        ## Import
+
+        AD secret backend libraries can be imported using the `path`, e.g.
+
+        ```sh
+        $ pulumi import vault:ad/secretLibrary:SecretLibrary role ad/library/bob
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] backend: The path the AD secret backend is mounted at,
+               with no leading or trailing `/`s.
+        :param pulumi.Input[_builtins.bool] disable_check_in_enforcement: Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        :param pulumi.Input[_builtins.int] max_ttl: The maximum password time-to-live in seconds. Defaults to the configuration
+               max_ttl if not provided.
+        :param pulumi.Input[_builtins.str] name: The name to identify this set of service accounts.
+               Must be unique within the backend.
+        :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*.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] service_account_names: Specifies the slice of service accounts mapped to this set.
+        :param pulumi.Input[_builtins.int] ttl: The password time-to-live in seconds. Defaults to the configuration
+               ttl if not provided.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: SecretLibraryArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        config = vault.ad.SecretBackend("config",
+            backend="ad",
+            binddn="CN=Administrator,CN=Users,DC=corp,DC=example,DC=net",
+            bindpass="SuperSecretPassw0rd",
+            url="ldaps://ad",
+            insecure_tls=True,
+            userdn="CN=Users,DC=corp,DC=example,DC=net")
+        qa = vault.ad.SecretLibrary("qa",
+            backend=config.backend,
+            name="qa",
+            service_account_names=[
+                "Bob",
+                "Mary",
+            ],
+            ttl=60,
+            disable_check_in_enforcement=True,
+            max_ttl=120)
+        ```
+
+        ## Import
+
+        AD secret backend libraries can be imported using the `path`, e.g.
+
+        ```sh
+        $ pulumi import vault:ad/secretLibrary:SecretLibrary role ad/library/bob
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param SecretLibraryArgs 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(SecretLibraryArgs, 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,
+                 backend: Optional[pulumi.Input[_builtins.str]] = None,
+                 disable_check_in_enforcement: Optional[pulumi.Input[_builtins.bool]] = None,
+                 max_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 service_account_names: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 ttl: Optional[pulumi.Input[_builtins.int]] = 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__ = SecretLibraryArgs.__new__(SecretLibraryArgs)
+
+            if backend is None and not opts.urn:
+                raise TypeError("Missing required property 'backend'")
+            __props__.__dict__["backend"] = backend
+            __props__.__dict__["disable_check_in_enforcement"] = disable_check_in_enforcement
+            __props__.__dict__["max_ttl"] = max_ttl
+            __props__.__dict__["name"] = name
+            __props__.__dict__["namespace"] = namespace
+            if service_account_names is None and not opts.urn:
+                raise TypeError("Missing required property 'service_account_names'")
+            __props__.__dict__["service_account_names"] = service_account_names
+            __props__.__dict__["ttl"] = ttl
+        super(SecretLibrary, __self__).__init__(
+            'vault:ad/secretLibrary:SecretLibrary',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            backend: Optional[pulumi.Input[_builtins.str]] = None,
+            disable_check_in_enforcement: Optional[pulumi.Input[_builtins.bool]] = None,
+            max_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+            name: Optional[pulumi.Input[_builtins.str]] = None,
+            namespace: Optional[pulumi.Input[_builtins.str]] = None,
+            service_account_names: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+            ttl: Optional[pulumi.Input[_builtins.int]] = None) -> 'SecretLibrary':
+        """
+        Get an existing SecretLibrary 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.str] backend: The path the AD secret backend is mounted at,
+               with no leading or trailing `/`s.
+        :param pulumi.Input[_builtins.bool] disable_check_in_enforcement: Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        :param pulumi.Input[_builtins.int] max_ttl: The maximum password time-to-live in seconds. Defaults to the configuration
+               max_ttl if not provided.
+        :param pulumi.Input[_builtins.str] name: The name to identify this set of service accounts.
+               Must be unique within the backend.
+        :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*.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] service_account_names: Specifies the slice of service accounts mapped to this set.
+        :param pulumi.Input[_builtins.int] ttl: The password time-to-live in seconds. Defaults to the configuration
+               ttl if not provided.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _SecretLibraryState.__new__(_SecretLibraryState)
+
+        __props__.__dict__["backend"] = backend
+        __props__.__dict__["disable_check_in_enforcement"] = disable_check_in_enforcement
+        __props__.__dict__["max_ttl"] = max_ttl
+        __props__.__dict__["name"] = name
+        __props__.__dict__["namespace"] = namespace
+        __props__.__dict__["service_account_names"] = service_account_names
+        __props__.__dict__["ttl"] = ttl
+        return SecretLibrary(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter
+    def backend(self) -> pulumi.Output[_builtins.str]:
+        """
+        The path the AD secret backend is mounted at,
+        with no leading or trailing `/`s.
+        """
+        return pulumi.get(self, "backend")
+
+    @_builtins.property
+    @pulumi.getter(name="disableCheckInEnforcement")
+    def disable_check_in_enforcement(self) -> pulumi.Output[Optional[_builtins.bool]]:
+        """
+        Disable enforcing that service accounts must be checked in by the entity or client token that checked them out.
+        """
+        return pulumi.get(self, "disable_check_in_enforcement")
+
+    @_builtins.property
+    @pulumi.getter(name="maxTtl")
+    def max_ttl(self) -> pulumi.Output[_builtins.int]:
+        """
+        The maximum password time-to-live in seconds. Defaults to the configuration
+        max_ttl if not provided.
+        """
+        return pulumi.get(self, "max_ttl")
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[_builtins.str]:
+        """
+        The name to identify this set of service accounts.
+        Must be unique within the backend.
+        """
+        return pulumi.get(self, "name")
+
+    @_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")
+
+    @_builtins.property
+    @pulumi.getter(name="serviceAccountNames")
+    def service_account_names(self) -> pulumi.Output[Sequence[_builtins.str]]:
+        """
+        Specifies the slice of service accounts mapped to this set.
+        """
+        return pulumi.get(self, "service_account_names")
+
+    @_builtins.property
+    @pulumi.getter
+    def ttl(self) -> pulumi.Output[_builtins.int]:
+        """
+        The password time-to-live in seconds. Defaults to the configuration
+        ttl if not provided.
+        """
+        return pulumi.get(self, "ttl")
+