pulumiverse-scaleway 1.23.0a1736837529__py3-none-any.whl

pulumiverse_scaleway/function_token.py

@@ -0,0 +1,460 @@
+# 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__ = ['FunctionTokenArgs', 'FunctionToken']
+
+@pulumi.input_type
+class FunctionTokenArgs:
+    def __init__(__self__, *,
+                 description: Optional[pulumi.Input[str]] = None,
+                 expires_at: Optional[pulumi.Input[str]] = None,
+                 function_id: Optional[pulumi.Input[str]] = None,
+                 namespace_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None):
+        """
+        The set of arguments for constructing a FunctionToken resource.
+        :param pulumi.Input[str] description: The description of the token.
+        :param pulumi.Input[str] expires_at: The expiration date of the token.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+               
+               > Only one of `namespace_id` or `function_id` must be set.
+        :param pulumi.Input[str] namespace_id: The unique identifier of the Functions namespace.
+        :param pulumi.Input[str] region: `region`). The region in which the namespace is created.
+               
+               > **Important** Updating any of the arguments above will recreate the token.
+        """
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if expires_at is not None:
+            pulumi.set(__self__, "expires_at", expires_at)
+        if function_id is not None:
+            pulumi.set(__self__, "function_id", function_id)
+        if namespace_id is not None:
+            pulumi.set(__self__, "namespace_id", namespace_id)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[str]]:
+        """
+        The description of the token.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="expiresAt")
+    def expires_at(self) -> Optional[pulumi.Input[str]]:
+        """
+        The expiration date of the token.
+        """
+        return pulumi.get(self, "expires_at")
+
+    @expires_at.setter
+    def expires_at(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "expires_at", value)
+
+    @property
+    @pulumi.getter(name="functionId")
+    def function_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The unique identifier of the function.
+
+        > Only one of `namespace_id` or `function_id` must be set.
+        """
+        return pulumi.get(self, "function_id")
+
+    @function_id.setter
+    def function_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "function_id", value)
+
+    @property
+    @pulumi.getter(name="namespaceId")
+    def namespace_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The unique identifier of the Functions namespace.
+        """
+        return pulumi.get(self, "namespace_id")
+
+    @namespace_id.setter
+    def namespace_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "namespace_id", value)
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        `region`). The region in which the namespace is created.
+
+        > **Important** Updating any of the arguments above will recreate the token.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+
+@pulumi.input_type
+class _FunctionTokenState:
+    def __init__(__self__, *,
+                 description: Optional[pulumi.Input[str]] = None,
+                 expires_at: Optional[pulumi.Input[str]] = None,
+                 function_id: Optional[pulumi.Input[str]] = None,
+                 namespace_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 token: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering FunctionToken resources.
+        :param pulumi.Input[str] description: The description of the token.
+        :param pulumi.Input[str] expires_at: The expiration date of the token.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+               
+               > Only one of `namespace_id` or `function_id` must be set.
+        :param pulumi.Input[str] namespace_id: The unique identifier of the Functions namespace.
+        :param pulumi.Input[str] region: `region`). The region in which the namespace is created.
+               
+               > **Important** Updating any of the arguments above will recreate the token.
+        :param pulumi.Input[str] token: The token.
+        """
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if expires_at is not None:
+            pulumi.set(__self__, "expires_at", expires_at)
+        if function_id is not None:
+            pulumi.set(__self__, "function_id", function_id)
+        if namespace_id is not None:
+            pulumi.set(__self__, "namespace_id", namespace_id)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+        if token is not None:
+            pulumi.set(__self__, "token", token)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[str]]:
+        """
+        The description of the token.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="expiresAt")
+    def expires_at(self) -> Optional[pulumi.Input[str]]:
+        """
+        The expiration date of the token.
+        """
+        return pulumi.get(self, "expires_at")
+
+    @expires_at.setter
+    def expires_at(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "expires_at", value)
+
+    @property
+    @pulumi.getter(name="functionId")
+    def function_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The unique identifier of the function.
+
+        > Only one of `namespace_id` or `function_id` must be set.
+        """
+        return pulumi.get(self, "function_id")
+
+    @function_id.setter
+    def function_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "function_id", value)
+
+    @property
+    @pulumi.getter(name="namespaceId")
+    def namespace_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The unique identifier of the Functions namespace.
+        """
+        return pulumi.get(self, "namespace_id")
+
+    @namespace_id.setter
+    def namespace_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "namespace_id", value)
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        `region`). The region in which the namespace is created.
+
+        > **Important** Updating any of the arguments above will recreate the token.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+    @property
+    @pulumi.getter
+    def token(self) -> Optional[pulumi.Input[str]]:
+        """
+        The token.
+        """
+        return pulumi.get(self, "token")
+
+    @token.setter
+    def token(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "token", value)
+
+
+class FunctionToken(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 description: Optional[pulumi.Input[str]] = None,
+                 expires_at: Optional[pulumi.Input[str]] = None,
+                 function_id: Optional[pulumi.Input[str]] = None,
+                 namespace_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        The `FunctionToken` resource allows you to create and manage authentication tokens for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
+
+        Refer to the Functions tokens [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/create-auth-token-from-console/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-tokens-list-all-tokens) for more information.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.FunctionNamespace("main", name="test-function-token-ns")
+        main_function = scaleway.Function("main",
+            namespace_id=main.id,
+            runtime="go118",
+            handler="Handle",
+            privacy="private")
+        # Namespace Token
+        namespace = scaleway.FunctionToken("namespace",
+            namespace_id=main.id,
+            expires_at="2022-10-18T11:35:15+02:00")
+        # Function Token
+        function = scaleway.FunctionToken("function", function_id=main_function.id)
+        ```
+
+        ## Import
+
+        Tokens can be imported using `{region}/{id}`, as shown below:
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:index/functionToken:FunctionToken main fr-par/11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] description: The description of the token.
+        :param pulumi.Input[str] expires_at: The expiration date of the token.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+               
+               > Only one of `namespace_id` or `function_id` must be set.
+        :param pulumi.Input[str] namespace_id: The unique identifier of the Functions namespace.
+        :param pulumi.Input[str] region: `region`). The region in which the namespace is created.
+               
+               > **Important** Updating any of the arguments above will recreate the token.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[FunctionTokenArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        The `FunctionToken` resource allows you to create and manage authentication tokens for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
+
+        Refer to the Functions tokens [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/create-auth-token-from-console/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-tokens-list-all-tokens) for more information.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        main = scaleway.FunctionNamespace("main", name="test-function-token-ns")
+        main_function = scaleway.Function("main",
+            namespace_id=main.id,
+            runtime="go118",
+            handler="Handle",
+            privacy="private")
+        # Namespace Token
+        namespace = scaleway.FunctionToken("namespace",
+            namespace_id=main.id,
+            expires_at="2022-10-18T11:35:15+02:00")
+        # Function Token
+        function = scaleway.FunctionToken("function", function_id=main_function.id)
+        ```
+
+        ## Import
+
+        Tokens can be imported using `{region}/{id}`, as shown below:
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:index/functionToken:FunctionToken main fr-par/11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param FunctionTokenArgs 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(FunctionTokenArgs, 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,
+                 description: Optional[pulumi.Input[str]] = None,
+                 expires_at: Optional[pulumi.Input[str]] = None,
+                 function_id: Optional[pulumi.Input[str]] = None,
+                 namespace_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = FunctionTokenArgs.__new__(FunctionTokenArgs)
+
+            __props__.__dict__["description"] = description
+            __props__.__dict__["expires_at"] = expires_at
+            __props__.__dict__["function_id"] = function_id
+            __props__.__dict__["namespace_id"] = namespace_id
+            __props__.__dict__["region"] = region
+            __props__.__dict__["token"] = None
+        secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["token"])
+        opts = pulumi.ResourceOptions.merge(opts, secret_opts)
+        super(FunctionToken, __self__).__init__(
+            'scaleway:index/functionToken:FunctionToken',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            description: Optional[pulumi.Input[str]] = None,
+            expires_at: Optional[pulumi.Input[str]] = None,
+            function_id: Optional[pulumi.Input[str]] = None,
+            namespace_id: Optional[pulumi.Input[str]] = None,
+            region: Optional[pulumi.Input[str]] = None,
+            token: Optional[pulumi.Input[str]] = None) -> 'FunctionToken':
+        """
+        Get an existing FunctionToken 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[str] description: The description of the token.
+        :param pulumi.Input[str] expires_at: The expiration date of the token.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+               
+               > Only one of `namespace_id` or `function_id` must be set.
+        :param pulumi.Input[str] namespace_id: The unique identifier of the Functions namespace.
+        :param pulumi.Input[str] region: `region`). The region in which the namespace is created.
+               
+               > **Important** Updating any of the arguments above will recreate the token.
+        :param pulumi.Input[str] token: The token.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _FunctionTokenState.__new__(_FunctionTokenState)
+
+        __props__.__dict__["description"] = description
+        __props__.__dict__["expires_at"] = expires_at
+        __props__.__dict__["function_id"] = function_id
+        __props__.__dict__["namespace_id"] = namespace_id
+        __props__.__dict__["region"] = region
+        __props__.__dict__["token"] = token
+        return FunctionToken(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter
+    def description(self) -> pulumi.Output[Optional[str]]:
+        """
+        The description of the token.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="expiresAt")
+    def expires_at(self) -> pulumi.Output[Optional[str]]:
+        """
+        The expiration date of the token.
+        """
+        return pulumi.get(self, "expires_at")
+
+    @property
+    @pulumi.getter(name="functionId")
+    def function_id(self) -> pulumi.Output[Optional[str]]:
+        """
+        The unique identifier of the function.
+
+        > Only one of `namespace_id` or `function_id` must be set.
+        """
+        return pulumi.get(self, "function_id")
+
+    @property
+    @pulumi.getter(name="namespaceId")
+    def namespace_id(self) -> pulumi.Output[Optional[str]]:
+        """
+        The unique identifier of the Functions namespace.
+        """
+        return pulumi.get(self, "namespace_id")
+
+    @property
+    @pulumi.getter
+    def region(self) -> pulumi.Output[str]:
+        """
+        `region`). The region in which the namespace is created.
+
+        > **Important** Updating any of the arguments above will recreate the token.
+        """
+        return pulumi.get(self, "region")
+
+    @property
+    @pulumi.getter
+    def token(self) -> pulumi.Output[str]:
+        """
+        The token.
+        """
+        return pulumi.get(self, "token")
+