pulumiverse-scaleway 1.17.0a1730194779__py3-none-any.whl → 1.18.0a1730280133__py3-none-any.whl

pulumiverse_scaleway/function_cron.py

@@ -27,13 +27,11 @@ class FunctionCronArgs:
         """
         The set of arguments for constructing a FunctionCron resource.
         :param pulumi.Input[str] args: The key-value mapping to define arguments that will be passed to your function’s event object
-               during
-        :param pulumi.Input[str] function_id: The function ID to link with your cron.
-        :param pulumi.Input[str] schedule: Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-               executed.
-        :param pulumi.Input[str] name: The name of the cron. If not provided, the name is generated.
+        :param pulumi.Input[str] function_id: The unique identifier of the function to link to your CRON trigger.
+        :param pulumi.Input[str] schedule: CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
+        :param pulumi.Input[str] name: The name of the function CRON trigger. If not provided, a random name is generated.
         :param pulumi.Input[str] region: `region`) The region
-               in where the job was created.
+               in which the function was created.
         """
         pulumi.set(__self__, "args", args)
         pulumi.set(__self__, "function_id", function_id)
@@ -48,7 +46,6 @@ class FunctionCronArgs:
     def args(self) -> pulumi.Input[str]:
         """
         The key-value mapping to define arguments that will be passed to your function’s event object
-        during
         """
         return pulumi.get(self, "args")
 
@@ -60,7 +57,7 @@ class FunctionCronArgs:
     @pulumi.getter(name="functionId")
     def function_id(self) -> pulumi.Input[str]:
         """
-        The function ID to link with your cron.
+        The unique identifier of the function to link to your CRON trigger.
         """
         return pulumi.get(self, "function_id")
 
@@ -72,8 +69,7 @@ class FunctionCronArgs:
     @pulumi.getter
     def schedule(self) -> pulumi.Input[str]:
         """
-        Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-        executed.
+        CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
         """
         return pulumi.get(self, "schedule")
 
@@ -85,7 +81,7 @@ class FunctionCronArgs:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        The name of the cron. If not provided, the name is generated.
+        The name of the function CRON trigger. If not provided, a random name is generated.
         """
         return pulumi.get(self, "name")
 
@@ -98,7 +94,7 @@ class FunctionCronArgs:
     def region(self) -> Optional[pulumi.Input[str]]:
         """
         `region`) The region
-        in where the job was created.
+        in which the function was created.
         """
         return pulumi.get(self, "region")
 
@@ -119,14 +115,12 @@ class _FunctionCronState:
         """
         Input properties used for looking up and filtering FunctionCron resources.
         :param pulumi.Input[str] args: The key-value mapping to define arguments that will be passed to your function’s event object
-               during
-        :param pulumi.Input[str] function_id: The function ID to link with your cron.
-        :param pulumi.Input[str] name: The name of the cron. If not provided, the name is generated.
+        :param pulumi.Input[str] function_id: The unique identifier of the function to link to your CRON trigger.
+        :param pulumi.Input[str] name: The name of the function CRON trigger. If not provided, a random name is generated.
         :param pulumi.Input[str] region: `region`) The region
-               in where the job was created.
-        :param pulumi.Input[str] schedule: Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-               executed.
-        :param pulumi.Input[str] status: The cron status.
+               in which the function was created.
+        :param pulumi.Input[str] schedule: CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
+        :param pulumi.Input[str] status: The CRON status.
         """
         if args is not None:
             pulumi.set(__self__, "args", args)
@@ -146,7 +140,6 @@ class _FunctionCronState:
     def args(self) -> Optional[pulumi.Input[str]]:
         """
         The key-value mapping to define arguments that will be passed to your function’s event object
-        during
         """
         return pulumi.get(self, "args")
 
@@ -158,7 +151,7 @@ class _FunctionCronState:
     @pulumi.getter(name="functionId")
     def function_id(self) -> Optional[pulumi.Input[str]]:
         """
-        The function ID to link with your cron.
+        The unique identifier of the function to link to your CRON trigger.
         """
         return pulumi.get(self, "function_id")
 
@@ -170,7 +163,7 @@ class _FunctionCronState:
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[str]]:
         """
-        The name of the cron. If not provided, the name is generated.
+        The name of the function CRON trigger. If not provided, a random name is generated.
         """
         return pulumi.get(self, "name")
 
@@ -183,7 +176,7 @@ class _FunctionCronState:
     def region(self) -> Optional[pulumi.Input[str]]:
         """
         `region`) The region
-        in where the job was created.
+        in which the function was created.
         """
         return pulumi.get(self, "region")
 
@@ -195,8 +188,7 @@ class _FunctionCronState:
     @pulumi.getter
     def schedule(self) -> Optional[pulumi.Input[str]]:
         """
-        Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-        executed.
+        CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
         """
         return pulumi.get(self, "schedule")
 
@@ -208,7 +200,7 @@ class _FunctionCronState:
     @pulumi.getter
     def status(self) -> Optional[pulumi.Input[str]]:
         """
-        The cron status.
+        The CRON status.
         """
         return pulumi.get(self, "status")
 
@@ -229,16 +221,14 @@ class FunctionCron(pulumi.CustomResource):
                  schedule: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Creates and manages Scaleway Function Triggers. For the moment, the feature is limited to CRON Schedule (time-based).
+        The `FunctionCron` resource allows you to create and manage CRON triggers for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
 
-        For more details about the limitation
-        check [functions-limitations](https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-limitations/).
-
-        You can check also
-        our [functions cron api documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#crons-942bf4).
+        Refer to the Functions CRON triggers [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-trigger-to-a-function/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-triggers-list-all-triggers) for more information.
 
         ## Example Usage
 
+        The following command allows you to add a CRON trigger to a Serverless Function.
+
         ```python
         import pulumi
         import json
@@ -268,7 +258,7 @@ class FunctionCron(pulumi.CustomResource):
 
         ## Import
 
-        Container Cron can be imported using the `{region}/{id}`, e.g.
+        Function Cron can be imported using `{region}/{id}`, as shown below:
 
         bash
 
@@ -279,13 +269,11 @@ class FunctionCron(pulumi.CustomResource):
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] args: The key-value mapping to define arguments that will be passed to your function’s event object
-               during
-        :param pulumi.Input[str] function_id: The function ID to link with your cron.
-        :param pulumi.Input[str] name: The name of the cron. If not provided, the name is generated.
+        :param pulumi.Input[str] function_id: The unique identifier of the function to link to your CRON trigger.
+        :param pulumi.Input[str] name: The name of the function CRON trigger. If not provided, a random name is generated.
         :param pulumi.Input[str] region: `region`) The region
-               in where the job was created.
-        :param pulumi.Input[str] schedule: Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-               executed.
+               in which the function was created.
+        :param pulumi.Input[str] schedule: CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
         """
         ...
     @overload
@@ -294,16 +282,14 @@ class FunctionCron(pulumi.CustomResource):
                  args: FunctionCronArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Creates and manages Scaleway Function Triggers. For the moment, the feature is limited to CRON Schedule (time-based).
+        The `FunctionCron` resource allows you to create and manage CRON triggers for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
 
-        For more details about the limitation
-        check [functions-limitations](https://www.scaleway.com/en/docs/compute/functions/reference-content/functions-limitations/).
-
-        You can check also
-        our [functions cron api documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#crons-942bf4).
+        Refer to the Functions CRON triggers [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-trigger-to-a-function/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-triggers-list-all-triggers) for more information.
 
         ## Example Usage
 
+        The following command allows you to add a CRON trigger to a Serverless Function.
+
         ```python
         import pulumi
         import json
@@ -333,7 +319,7 @@ class FunctionCron(pulumi.CustomResource):
 
         ## Import
 
-        Container Cron can be imported using the `{region}/{id}`, e.g.
+        Function Cron can be imported using `{region}/{id}`, as shown below:
 
         bash
 
@@ -406,14 +392,12 @@ class FunctionCron(pulumi.CustomResource):
         :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] args: The key-value mapping to define arguments that will be passed to your function’s event object
-               during
-        :param pulumi.Input[str] function_id: The function ID to link with your cron.
-        :param pulumi.Input[str] name: The name of the cron. If not provided, the name is generated.
+        :param pulumi.Input[str] function_id: The unique identifier of the function to link to your CRON trigger.
+        :param pulumi.Input[str] name: The name of the function CRON trigger. If not provided, a random name is generated.
         :param pulumi.Input[str] region: `region`) The region
-               in where the job was created.
-        :param pulumi.Input[str] schedule: Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-               executed.
-        :param pulumi.Input[str] status: The cron status.
+               in which the function was created.
+        :param pulumi.Input[str] schedule: CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
+        :param pulumi.Input[str] status: The CRON status.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -432,7 +416,6 @@ class FunctionCron(pulumi.CustomResource):
     def args(self) -> pulumi.Output[str]:
         """
         The key-value mapping to define arguments that will be passed to your function’s event object
-        during
         """
         return pulumi.get(self, "args")
 
@@ -440,7 +423,7 @@ class FunctionCron(pulumi.CustomResource):
     @pulumi.getter(name="functionId")
     def function_id(self) -> pulumi.Output[str]:
         """
-        The function ID to link with your cron.
+        The unique identifier of the function to link to your CRON trigger.
         """
         return pulumi.get(self, "function_id")
 
@@ -448,7 +431,7 @@ class FunctionCron(pulumi.CustomResource):
     @pulumi.getter
     def name(self) -> pulumi.Output[str]:
         """
-        The name of the cron. If not provided, the name is generated.
+        The name of the function CRON trigger. If not provided, a random name is generated.
         """
         return pulumi.get(self, "name")
 
@@ -457,7 +440,7 @@ class FunctionCron(pulumi.CustomResource):
     def region(self) -> pulumi.Output[str]:
         """
         `region`) The region
-        in where the job was created.
+        in which the function was created.
         """
         return pulumi.get(self, "region")
 
@@ -465,8 +448,7 @@ class FunctionCron(pulumi.CustomResource):
     @pulumi.getter
     def schedule(self) -> pulumi.Output[str]:
         """
-        Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
-        executed.
+        CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
         """
         return pulumi.get(self, "schedule")
 
@@ -474,7 +456,7 @@ class FunctionCron(pulumi.CustomResource):
     @pulumi.getter
     def status(self) -> pulumi.Output[str]:
         """
-        The cron status.
+        The CRON status.
         """
         return pulumi.get(self, "status")
 

pulumiverse_scaleway/function_domain.py

@@ -24,12 +24,13 @@ class FunctionDomainArgs:
                  region: Optional[pulumi.Input[str]] = None):
         """
         The set of arguments for constructing a FunctionDomain resource.
-        :param pulumi.Input[str] function_id: The ID of the function you want to create a domain with.
-        :param pulumi.Input[str] hostname: The hostname that should resolve to your function id native domain.
-               You should use a CNAME domain record that point to your native function `domain_name` for it.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+        :param pulumi.Input[str] hostname: The hostname with a CNAME record.
                
-               > **Important** Updates to `function_id` or `hostname` will recreate the domain.
-        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in where the domain was created.
+               We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
+               
+               > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
+        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in which the domain was created.
         """
         pulumi.set(__self__, "function_id", function_id)
         pulumi.set(__self__, "hostname", hostname)
@@ -40,7 +41,7 @@ class FunctionDomainArgs:
     @pulumi.getter(name="functionId")
     def function_id(self) -> pulumi.Input[str]:
         """
-        The ID of the function you want to create a domain with.
+        The unique identifier of the function.
         """
         return pulumi.get(self, "function_id")
 
@@ -52,10 +53,11 @@ class FunctionDomainArgs:
     @pulumi.getter
     def hostname(self) -> pulumi.Input[str]:
         """
-        The hostname that should resolve to your function id native domain.
-        You should use a CNAME domain record that point to your native function `domain_name` for it.
+        The hostname with a CNAME record.
+
+        We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
 
-        > **Important** Updates to `function_id` or `hostname` will recreate the domain.
+        > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
         """
         return pulumi.get(self, "hostname")
 
@@ -67,7 +69,7 @@ class FunctionDomainArgs:
     @pulumi.getter
     def region(self) -> Optional[pulumi.Input[str]]:
         """
-        (Defaults to provider `region`) The region in where the domain was created.
+        (Defaults to provider `region`) The region in which the domain was created.
         """
         return pulumi.get(self, "region")
 
@@ -85,13 +87,14 @@ class _FunctionDomainState:
                  url: Optional[pulumi.Input[str]] = None):
         """
         Input properties used for looking up and filtering FunctionDomain resources.
-        :param pulumi.Input[str] function_id: The ID of the function you want to create a domain with.
-        :param pulumi.Input[str] hostname: The hostname that should resolve to your function id native domain.
-               You should use a CNAME domain record that point to your native function `domain_name` for it.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+        :param pulumi.Input[str] hostname: The hostname with a CNAME record.
+               
+               We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
                
-               > **Important** Updates to `function_id` or `hostname` will recreate the domain.
-        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in where the domain was created.
-        :param pulumi.Input[str] url: The URL that triggers the function
+               > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
+        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in which the domain was created.
+        :param pulumi.Input[str] url: The URL used to query the function.
         """
         if function_id is not None:
             pulumi.set(__self__, "function_id", function_id)
@@ -106,7 +109,7 @@ class _FunctionDomainState:
     @pulumi.getter(name="functionId")
     def function_id(self) -> Optional[pulumi.Input[str]]:
         """
-        The ID of the function you want to create a domain with.
+        The unique identifier of the function.
         """
         return pulumi.get(self, "function_id")
 
@@ -118,10 +121,11 @@ class _FunctionDomainState:
     @pulumi.getter
     def hostname(self) -> Optional[pulumi.Input[str]]:
         """
-        The hostname that should resolve to your function id native domain.
-        You should use a CNAME domain record that point to your native function `domain_name` for it.
+        The hostname with a CNAME record.
 
-        > **Important** Updates to `function_id` or `hostname` will recreate the domain.
+        We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
+
+        > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
         """
         return pulumi.get(self, "hostname")
 
@@ -133,7 +137,7 @@ class _FunctionDomainState:
     @pulumi.getter
     def region(self) -> Optional[pulumi.Input[str]]:
         """
-        (Defaults to provider `region`) The region in where the domain was created.
+        (Defaults to provider `region`) The region in which the domain was created.
         """
         return pulumi.get(self, "region")
 
@@ -145,7 +149,7 @@ class _FunctionDomainState:
     @pulumi.getter
     def url(self) -> Optional[pulumi.Input[str]]:
         """
-        The URL that triggers the function
+        The URL used to query the function.
         """
         return pulumi.get(self, "url")
 
@@ -164,12 +168,13 @@ class FunctionDomain(pulumi.CustomResource):
                  region: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Creates and manages Scaleway Function Domain bindings.
-        For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions).
+        The `FunctionDomain` resource allows you to create and manage domain name bindings for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
+
+        Refer to the Functions domain [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-a-custom-domain-name-to-a-function/) and the [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-domains-list-all-domain-name-bindings) for more information.
 
         ## Example Usage
 
-        ### Basic
+        This command allows to bind a custom domain name to a function.
 
         ```python
         import pulumi
@@ -191,7 +196,7 @@ class FunctionDomain(pulumi.CustomResource):
 
         ## Import
 
-        Domain can be imported using the `{region}/{id}`, e.g.
+        Function domain binding can be imported using `{region}/{id}`, as shown below:
 
         bash
 
@@ -201,12 +206,13 @@ class FunctionDomain(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] function_id: The ID of the function you want to create a domain with.
-        :param pulumi.Input[str] hostname: The hostname that should resolve to your function id native domain.
-               You should use a CNAME domain record that point to your native function `domain_name` for it.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+        :param pulumi.Input[str] hostname: The hostname with a CNAME record.
                
-               > **Important** Updates to `function_id` or `hostname` will recreate the domain.
-        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in where the domain was created.
+               We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
+               
+               > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
+        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in which the domain was created.
         """
         ...
     @overload
@@ -215,12 +221,13 @@ class FunctionDomain(pulumi.CustomResource):
                  args: FunctionDomainArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Creates and manages Scaleway Function Domain bindings.
-        For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions).
+        The `FunctionDomain` resource allows you to create and manage domain name bindings for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
+
+        Refer to the Functions domain [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-a-custom-domain-name-to-a-function/) and the [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-domains-list-all-domain-name-bindings) for more information.
 
         ## Example Usage
 
-        ### Basic
+        This command allows to bind a custom domain name to a function.
 
         ```python
         import pulumi
@@ -242,7 +249,7 @@ class FunctionDomain(pulumi.CustomResource):
 
         ## Import
 
-        Domain can be imported using the `{region}/{id}`, e.g.
+        Function domain binding can be imported using `{region}/{id}`, as shown below:
 
         bash
 
@@ -306,13 +313,14 @@ class FunctionDomain(pulumi.CustomResource):
         :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] function_id: The ID of the function you want to create a domain with.
-        :param pulumi.Input[str] hostname: The hostname that should resolve to your function id native domain.
-               You should use a CNAME domain record that point to your native function `domain_name` for it.
+        :param pulumi.Input[str] function_id: The unique identifier of the function.
+        :param pulumi.Input[str] hostname: The hostname with a CNAME record.
                
-               > **Important** Updates to `function_id` or `hostname` will recreate the domain.
-        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in where the domain was created.
-        :param pulumi.Input[str] url: The URL that triggers the function
+               We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
+               
+               > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
+        :param pulumi.Input[str] region: (Defaults to provider `region`) The region in which the domain was created.
+        :param pulumi.Input[str] url: The URL used to query the function.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -328,7 +336,7 @@ class FunctionDomain(pulumi.CustomResource):
     @pulumi.getter(name="functionId")
     def function_id(self) -> pulumi.Output[str]:
         """
-        The ID of the function you want to create a domain with.
+        The unique identifier of the function.
         """
         return pulumi.get(self, "function_id")
 
@@ -336,10 +344,11 @@ class FunctionDomain(pulumi.CustomResource):
     @pulumi.getter
     def hostname(self) -> pulumi.Output[str]:
         """
-        The hostname that should resolve to your function id native domain.
-        You should use a CNAME domain record that point to your native function `domain_name` for it.
+        The hostname with a CNAME record.
+
+        We recommend you use a CNAME domain record that point to your native function `domain_name` for it.
 
-        > **Important** Updates to `function_id` or `hostname` will recreate the domain.
+        > **Important** Updating the `function_id` or `hostname` arguments will recreate the domain.
         """
         return pulumi.get(self, "hostname")
 
@@ -347,7 +356,7 @@ class FunctionDomain(pulumi.CustomResource):
     @pulumi.getter
     def region(self) -> pulumi.Output[str]:
         """
-        (Defaults to provider `region`) The region in where the domain was created.
+        (Defaults to provider `region`) The region in which the domain was created.
         """
         return pulumi.get(self, "region")
 
@@ -355,7 +364,7 @@ class FunctionDomain(pulumi.CustomResource):
     @pulumi.getter
     def url(self) -> pulumi.Output[str]:
         """
-        The URL that triggers the function
+        The URL used to query the function.
         """
         return pulumi.get(self, "url")