pulumi-vault 7.6.0a1764657486__py3-none-any.whl

pulumi_vault/identity/oidc_key.py

@@ -0,0 +1,474 @@
+# 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__ = ['OidcKeyArgs', 'OidcKey']
+
+@pulumi.input_type
+class OidcKeyArgs:
+    def __init__(__self__, *,
+                 algorithm: Optional[pulumi.Input[_builtins.str]] = None,
+                 allowed_client_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 rotation_period: Optional[pulumi.Input[_builtins.int]] = None,
+                 verification_ttl: Optional[pulumi.Input[_builtins.int]] = None):
+        """
+        The set of arguments for constructing a OidcKey resource.
+        :param pulumi.Input[_builtins.str] algorithm: Signing algorithm to use. Signing algorithm to use.
+               Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] allowed_client_ids: Array of role client ID allowed to use this key for signing. If
+               empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        :param pulumi.Input[_builtins.str] name: Name of the OIDC Key to create.
+        :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] rotation_period: How often to generate a new signing key in number of seconds
+        :param pulumi.Input[_builtins.int] verification_ttl: "Controls how long the public portion of a signing key will be
+               available for verification after being rotated in seconds.
+        """
+        if algorithm is not None:
+            pulumi.set(__self__, "algorithm", algorithm)
+        if allowed_client_ids is not None:
+            pulumi.set(__self__, "allowed_client_ids", allowed_client_ids)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if rotation_period is not None:
+            pulumi.set(__self__, "rotation_period", rotation_period)
+        if verification_ttl is not None:
+            pulumi.set(__self__, "verification_ttl", verification_ttl)
+
+    @_builtins.property
+    @pulumi.getter
+    def algorithm(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        Signing algorithm to use. Signing algorithm to use.
+        Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        """
+        return pulumi.get(self, "algorithm")
+
+    @algorithm.setter
+    def algorithm(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "algorithm", value)
+
+    @_builtins.property
+    @pulumi.getter(name="allowedClientIds")
+    def allowed_client_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        Array of role client ID allowed to use this key for signing. If
+        empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        """
+        return pulumi.get(self, "allowed_client_ids")
+
+    @allowed_client_ids.setter
+    def allowed_client_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "allowed_client_ids", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        Name of the OIDC Key to create.
+        """
+        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="rotationPeriod")
+    def rotation_period(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        How often to generate a new signing key in number of seconds
+        """
+        return pulumi.get(self, "rotation_period")
+
+    @rotation_period.setter
+    def rotation_period(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "rotation_period", value)
+
+    @_builtins.property
+    @pulumi.getter(name="verificationTtl")
+    def verification_ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        "Controls how long the public portion of a signing key will be
+        available for verification after being rotated in seconds.
+        """
+        return pulumi.get(self, "verification_ttl")
+
+    @verification_ttl.setter
+    def verification_ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "verification_ttl", value)
+
+
+@pulumi.input_type
+class _OidcKeyState:
+    def __init__(__self__, *,
+                 algorithm: Optional[pulumi.Input[_builtins.str]] = None,
+                 allowed_client_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 rotation_period: Optional[pulumi.Input[_builtins.int]] = None,
+                 verification_ttl: Optional[pulumi.Input[_builtins.int]] = None):
+        """
+        Input properties used for looking up and filtering OidcKey resources.
+        :param pulumi.Input[_builtins.str] algorithm: Signing algorithm to use. Signing algorithm to use.
+               Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] allowed_client_ids: Array of role client ID allowed to use this key for signing. If
+               empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        :param pulumi.Input[_builtins.str] name: Name of the OIDC Key to create.
+        :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] rotation_period: How often to generate a new signing key in number of seconds
+        :param pulumi.Input[_builtins.int] verification_ttl: "Controls how long the public portion of a signing key will be
+               available for verification after being rotated in seconds.
+        """
+        if algorithm is not None:
+            pulumi.set(__self__, "algorithm", algorithm)
+        if allowed_client_ids is not None:
+            pulumi.set(__self__, "allowed_client_ids", allowed_client_ids)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if rotation_period is not None:
+            pulumi.set(__self__, "rotation_period", rotation_period)
+        if verification_ttl is not None:
+            pulumi.set(__self__, "verification_ttl", verification_ttl)
+
+    @_builtins.property
+    @pulumi.getter
+    def algorithm(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        Signing algorithm to use. Signing algorithm to use.
+        Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        """
+        return pulumi.get(self, "algorithm")
+
+    @algorithm.setter
+    def algorithm(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "algorithm", value)
+
+    @_builtins.property
+    @pulumi.getter(name="allowedClientIds")
+    def allowed_client_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        Array of role client ID allowed to use this key for signing. If
+        empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        """
+        return pulumi.get(self, "allowed_client_ids")
+
+    @allowed_client_ids.setter
+    def allowed_client_ids(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "allowed_client_ids", value)
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        Name of the OIDC Key to create.
+        """
+        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="rotationPeriod")
+    def rotation_period(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        How often to generate a new signing key in number of seconds
+        """
+        return pulumi.get(self, "rotation_period")
+
+    @rotation_period.setter
+    def rotation_period(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "rotation_period", value)
+
+    @_builtins.property
+    @pulumi.getter(name="verificationTtl")
+    def verification_ttl(self) -> Optional[pulumi.Input[_builtins.int]]:
+        """
+        "Controls how long the public portion of a signing key will be
+        available for verification after being rotated in seconds.
+        """
+        return pulumi.get(self, "verification_ttl")
+
+    @verification_ttl.setter
+    def verification_ttl(self, value: Optional[pulumi.Input[_builtins.int]]):
+        pulumi.set(self, "verification_ttl", value)
+
+
+@pulumi.type_token("vault:identity/oidcKey:OidcKey")
+class OidcKey(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 algorithm: Optional[pulumi.Input[_builtins.str]] = None,
+                 allowed_client_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 rotation_period: Optional[pulumi.Input[_builtins.int]] = None,
+                 verification_ttl: Optional[pulumi.Input[_builtins.int]] = None,
+                 __props__=None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        key = vault.identity.OidcKey("key",
+            name="key",
+            algorithm="RS256")
+        role = vault.identity.OidcRole("role",
+            name="role",
+            key=key.name)
+        role_oidc_key_allowed_client_id = vault.identity.OidcKeyAllowedClientID("role",
+            key_name=key.name,
+            allowed_client_id=role.client_id)
+        ```
+
+        ## Import
+
+        The key can be imported with the key name, for example:
+
+        ```sh
+        $ pulumi import vault:identity/oidcKey:OidcKey key key
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[_builtins.str] algorithm: Signing algorithm to use. Signing algorithm to use.
+               Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] allowed_client_ids: Array of role client ID allowed to use this key for signing. If
+               empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        :param pulumi.Input[_builtins.str] name: Name of the OIDC Key to create.
+        :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] rotation_period: How often to generate a new signing key in number of seconds
+        :param pulumi.Input[_builtins.int] verification_ttl: "Controls how long the public portion of a signing key will be
+               available for verification after being rotated in seconds.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[OidcKeyArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        key = vault.identity.OidcKey("key",
+            name="key",
+            algorithm="RS256")
+        role = vault.identity.OidcRole("role",
+            name="role",
+            key=key.name)
+        role_oidc_key_allowed_client_id = vault.identity.OidcKeyAllowedClientID("role",
+            key_name=key.name,
+            allowed_client_id=role.client_id)
+        ```
+
+        ## Import
+
+        The key can be imported with the key name, for example:
+
+        ```sh
+        $ pulumi import vault:identity/oidcKey:OidcKey key key
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param OidcKeyArgs 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(OidcKeyArgs, 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,
+                 algorithm: Optional[pulumi.Input[_builtins.str]] = None,
+                 allowed_client_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+                 name: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 rotation_period: Optional[pulumi.Input[_builtins.int]] = None,
+                 verification_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__ = OidcKeyArgs.__new__(OidcKeyArgs)
+
+            __props__.__dict__["algorithm"] = algorithm
+            __props__.__dict__["allowed_client_ids"] = allowed_client_ids
+            __props__.__dict__["name"] = name
+            __props__.__dict__["namespace"] = namespace
+            __props__.__dict__["rotation_period"] = rotation_period
+            __props__.__dict__["verification_ttl"] = verification_ttl
+        super(OidcKey, __self__).__init__(
+            'vault:identity/oidcKey:OidcKey',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            algorithm: Optional[pulumi.Input[_builtins.str]] = None,
+            allowed_client_ids: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None,
+            name: Optional[pulumi.Input[_builtins.str]] = None,
+            namespace: Optional[pulumi.Input[_builtins.str]] = None,
+            rotation_period: Optional[pulumi.Input[_builtins.int]] = None,
+            verification_ttl: Optional[pulumi.Input[_builtins.int]] = None) -> 'OidcKey':
+        """
+        Get an existing OidcKey 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] algorithm: Signing algorithm to use. Signing algorithm to use.
+               Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] allowed_client_ids: Array of role client ID allowed to use this key for signing. If
+               empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        :param pulumi.Input[_builtins.str] name: Name of the OIDC Key to create.
+        :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] rotation_period: How often to generate a new signing key in number of seconds
+        :param pulumi.Input[_builtins.int] verification_ttl: "Controls how long the public portion of a signing key will be
+               available for verification after being rotated in seconds.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _OidcKeyState.__new__(_OidcKeyState)
+
+        __props__.__dict__["algorithm"] = algorithm
+        __props__.__dict__["allowed_client_ids"] = allowed_client_ids
+        __props__.__dict__["name"] = name
+        __props__.__dict__["namespace"] = namespace
+        __props__.__dict__["rotation_period"] = rotation_period
+        __props__.__dict__["verification_ttl"] = verification_ttl
+        return OidcKey(resource_name, opts=opts, __props__=__props__)
+
+    @_builtins.property
+    @pulumi.getter
+    def algorithm(self) -> pulumi.Output[Optional[_builtins.str]]:
+        """
+        Signing algorithm to use. Signing algorithm to use.
+        Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
+        """
+        return pulumi.get(self, "algorithm")
+
+    @_builtins.property
+    @pulumi.getter(name="allowedClientIds")
+    def allowed_client_ids(self) -> pulumi.Output[Sequence[_builtins.str]]:
+        """
+        Array of role client ID allowed to use this key for signing. If
+        empty, no roles are allowed. If `["*"]`, all roles are allowed.
+        """
+        return pulumi.get(self, "allowed_client_ids")
+
+    @_builtins.property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[_builtins.str]:
+        """
+        Name of the OIDC Key to create.
+        """
+        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="rotationPeriod")
+    def rotation_period(self) -> pulumi.Output[Optional[_builtins.int]]:
+        """
+        How often to generate a new signing key in number of seconds
+        """
+        return pulumi.get(self, "rotation_period")
+
+    @_builtins.property
+    @pulumi.getter(name="verificationTtl")
+    def verification_ttl(self) -> pulumi.Output[Optional[_builtins.int]]:
+        """
+        "Controls how long the public portion of a signing key will be
+        available for verification after being rotated in seconds.
+        """
+        return pulumi.get(self, "verification_ttl")
+