pulumiverse-scaleway 1.24.0a1741680905__py3-none-any.whl → 1.25.0__py3-none-any.whl

pulumiverse_scaleway/observability/cockpit.py

@@ -0,0 +1,325 @@
+# 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
+from . import outputs
+from ._inputs import *
+
+__all__ = ['CockpitArgs', 'Cockpit']
+
+@pulumi.input_type
+class CockpitArgs:
+    def __init__(__self__, *,
+                 plan: Optional[pulumi.Input[str]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None):
+        """
+        The set of arguments for constructing a Cockpit resource.
+        :param pulumi.Input[str] plan: Name of the plan to use. Available plans are: free, premium, and custom.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        """
+        if plan is not None:
+            warnings.warn("""The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""", DeprecationWarning)
+            pulumi.log.warn("""plan is deprecated: The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""")
+        if plan is not None:
+            pulumi.set(__self__, "plan", plan)
+        if project_id is not None:
+            pulumi.set(__self__, "project_id", project_id)
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""")
+    def plan(self) -> Optional[pulumi.Input[str]]:
+        """
+        Name of the plan to use. Available plans are: free, premium, and custom.
+        """
+        return pulumi.get(self, "plan")
+
+    @plan.setter
+    def plan(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "plan", value)
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        ) The ID of the Project the Cockpit is associated with.
+        """
+        return pulumi.get(self, "project_id")
+
+    @project_id.setter
+    def project_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "project_id", value)
+
+
+@pulumi.input_type
+class _CockpitState:
+    def __init__(__self__, *,
+                 endpoints: Optional[pulumi.Input[Sequence[pulumi.Input['CockpitEndpointArgs']]]] = None,
+                 plan: Optional[pulumi.Input[str]] = None,
+                 plan_id: Optional[pulumi.Input[str]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None,
+                 push_urls: Optional[pulumi.Input[Sequence[pulumi.Input['CockpitPushUrlArgs']]]] = None):
+        """
+        Input properties used for looking up and filtering Cockpit resources.
+        :param pulumi.Input[Sequence[pulumi.Input['CockpitEndpointArgs']]] endpoints: (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
+        :param pulumi.Input[str] plan: Name of the plan to use. Available plans are: free, premium, and custom.
+        :param pulumi.Input[str] plan_id: (Deprecated) The ID of the current pricing plan.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[Sequence[pulumi.Input['CockpitPushUrlArgs']]] push_urls: [DEPRECATED] Push_url
+        """
+        if endpoints is not None:
+            warnings.warn("""Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.""", DeprecationWarning)
+            pulumi.log.warn("""endpoints is deprecated: Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.""")
+        if endpoints is not None:
+            pulumi.set(__self__, "endpoints", endpoints)
+        if plan is not None:
+            warnings.warn("""The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""", DeprecationWarning)
+            pulumi.log.warn("""plan is deprecated: The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""")
+        if plan is not None:
+            pulumi.set(__self__, "plan", plan)
+        if plan_id is not None:
+            warnings.warn("""The 'plan_id' attribute is deprecated and will be removed in a future release.""", DeprecationWarning)
+            pulumi.log.warn("""plan_id is deprecated: The 'plan_id' attribute is deprecated and will be removed in a future release.""")
+        if plan_id is not None:
+            pulumi.set(__self__, "plan_id", plan_id)
+        if project_id is not None:
+            pulumi.set(__self__, "project_id", project_id)
+        if push_urls is not None:
+            warnings.warn("""Please use `observability.Source` instead""", DeprecationWarning)
+            pulumi.log.warn("""push_urls is deprecated: Please use `observability.Source` instead""")
+        if push_urls is not None:
+            pulumi.set(__self__, "push_urls", push_urls)
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.""")
+    def endpoints(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CockpitEndpointArgs']]]]:
+        """
+        (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
+        """
+        return pulumi.get(self, "endpoints")
+
+    @endpoints.setter
+    def endpoints(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CockpitEndpointArgs']]]]):
+        pulumi.set(self, "endpoints", value)
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""")
+    def plan(self) -> Optional[pulumi.Input[str]]:
+        """
+        Name of the plan to use. Available plans are: free, premium, and custom.
+        """
+        return pulumi.get(self, "plan")
+
+    @plan.setter
+    def plan(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "plan", value)
+
+    @property
+    @pulumi.getter(name="planId")
+    @_utilities.deprecated("""The 'plan_id' attribute is deprecated and will be removed in a future release.""")
+    def plan_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        (Deprecated) The ID of the current pricing plan.
+        """
+        return pulumi.get(self, "plan_id")
+
+    @plan_id.setter
+    def plan_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "plan_id", value)
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        ) The ID of the Project the Cockpit is associated with.
+        """
+        return pulumi.get(self, "project_id")
+
+    @project_id.setter
+    def project_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "project_id", value)
+
+    @property
+    @pulumi.getter(name="pushUrls")
+    @_utilities.deprecated("""Please use `observability.Source` instead""")
+    def push_urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CockpitPushUrlArgs']]]]:
+        """
+        [DEPRECATED] Push_url
+        """
+        return pulumi.get(self, "push_urls")
+
+    @push_urls.setter
+    def push_urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CockpitPushUrlArgs']]]]):
+        pulumi.set(self, "push_urls", value)
+
+
+class Cockpit(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 plan: Optional[pulumi.Input[str]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        ## Import
+
+        This section explains how to import a Cockpit using its `{project_id}`.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:observability/cockpit:Cockpit main 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] plan: Name of the plan to use. Available plans are: free, premium, and custom.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[CockpitArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Import
+
+        This section explains how to import a Cockpit using its `{project_id}`.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:observability/cockpit:Cockpit main 11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param CockpitArgs 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(CockpitArgs, 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,
+                 plan: Optional[pulumi.Input[str]] = None,
+                 project_id: 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__ = CockpitArgs.__new__(CockpitArgs)
+
+            __props__.__dict__["plan"] = plan
+            __props__.__dict__["project_id"] = project_id
+            __props__.__dict__["endpoints"] = None
+            __props__.__dict__["plan_id"] = None
+            __props__.__dict__["push_urls"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="scaleway:index/cockpit:Cockpit")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(Cockpit, __self__).__init__(
+            'scaleway:observability/cockpit:Cockpit',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            endpoints: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CockpitEndpointArgs', 'CockpitEndpointArgsDict']]]]] = None,
+            plan: Optional[pulumi.Input[str]] = None,
+            plan_id: Optional[pulumi.Input[str]] = None,
+            project_id: Optional[pulumi.Input[str]] = None,
+            push_urls: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CockpitPushUrlArgs', 'CockpitPushUrlArgsDict']]]]] = None) -> 'Cockpit':
+        """
+        Get an existing Cockpit 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[Sequence[pulumi.Input[Union['CockpitEndpointArgs', 'CockpitEndpointArgsDict']]]] endpoints: (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
+        :param pulumi.Input[str] plan: Name of the plan to use. Available plans are: free, premium, and custom.
+        :param pulumi.Input[str] plan_id: (Deprecated) The ID of the current pricing plan.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[Sequence[pulumi.Input[Union['CockpitPushUrlArgs', 'CockpitPushUrlArgsDict']]]] push_urls: [DEPRECATED] Push_url
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _CockpitState.__new__(_CockpitState)
+
+        __props__.__dict__["endpoints"] = endpoints
+        __props__.__dict__["plan"] = plan
+        __props__.__dict__["plan_id"] = plan_id
+        __props__.__dict__["project_id"] = project_id
+        __props__.__dict__["push_urls"] = push_urls
+        return Cockpit(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.""")
+    def endpoints(self) -> pulumi.Output[Sequence['outputs.CockpitEndpoint']]:
+        """
+        (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
+        """
+        return pulumi.get(self, "endpoints")
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.""")
+    def plan(self) -> pulumi.Output[Optional[str]]:
+        """
+        Name of the plan to use. Available plans are: free, premium, and custom.
+        """
+        return pulumi.get(self, "plan")
+
+    @property
+    @pulumi.getter(name="planId")
+    @_utilities.deprecated("""The 'plan_id' attribute is deprecated and will be removed in a future release.""")
+    def plan_id(self) -> pulumi.Output[str]:
+        """
+        (Deprecated) The ID of the current pricing plan.
+        """
+        return pulumi.get(self, "plan_id")
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> pulumi.Output[str]:
+        """
+        ) The ID of the Project the Cockpit is associated with.
+        """
+        return pulumi.get(self, "project_id")
+
+    @property
+    @pulumi.getter(name="pushUrls")
+    @_utilities.deprecated("""Please use `observability.Source` instead""")
+    def push_urls(self) -> pulumi.Output[Sequence['outputs.CockpitPushUrl']]:
+        """
+        [DEPRECATED] Push_url
+        """
+        return pulumi.get(self, "push_urls")
+

pulumiverse_scaleway/observability/get_instance.py

@@ -0,0 +1,205 @@
+# 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
+from . import outputs
+
+__all__ = [
+    'GetInstanceResult',
+    'AwaitableGetInstanceResult',
+    'get_instance',
+    'get_instance_output',
+]
+
+@pulumi.output_type
+class GetInstanceResult:
+    """
+    A collection of values returned by getInstance.
+    """
+    def __init__(__self__, endpoints=None, id=None, plan=None, plan_id=None, project_id=None, push_urls=None):
+        if endpoints and not isinstance(endpoints, list):
+            raise TypeError("Expected argument 'endpoints' to be a list")
+        pulumi.set(__self__, "endpoints", endpoints)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if plan and not isinstance(plan, str):
+            raise TypeError("Expected argument 'plan' to be a str")
+        pulumi.set(__self__, "plan", plan)
+        if plan_id and not isinstance(plan_id, str):
+            raise TypeError("Expected argument 'plan_id' to be a str")
+        pulumi.set(__self__, "plan_id", plan_id)
+        if project_id and not isinstance(project_id, str):
+            raise TypeError("Expected argument 'project_id' to be a str")
+        pulumi.set(__self__, "project_id", project_id)
+        if push_urls and not isinstance(push_urls, list):
+            raise TypeError("Expected argument 'push_urls' to be a list")
+        pulumi.set(__self__, "push_urls", push_urls)
+
+    @property
+    @pulumi.getter
+    def endpoints(self) -> Sequence['outputs.GetInstanceEndpointResult']:
+        """
+        (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
+        """
+        return pulumi.get(self, "endpoints")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    @_utilities.deprecated("""The 'plan' attribute is deprecated and will be removed in a future version. Any changes to this attribute will have no effect.""")
+    def plan(self) -> str:
+        return pulumi.get(self, "plan")
+
+    @property
+    @pulumi.getter(name="planId")
+    def plan_id(self) -> str:
+        """
+        (Deprecated) ID of the current pricing plan
+        """
+        return pulumi.get(self, "plan_id")
+
+    @property
+    @pulumi.getter(name="projectId")
+    def project_id(self) -> Optional[str]:
+        return pulumi.get(self, "project_id")
+
+    @property
+    @pulumi.getter(name="pushUrls")
+    def push_urls(self) -> Sequence['outputs.GetInstancePushUrlResult']:
+        return pulumi.get(self, "push_urls")
+
+
+class AwaitableGetInstanceResult(GetInstanceResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetInstanceResult(
+            endpoints=self.endpoints,
+            id=self.id,
+            plan=self.plan,
+            plan_id=self.plan_id,
+            project_id=self.project_id,
+            push_urls=self.push_urls)
+
+
+def get_instance(project_id: Optional[str] = None,
+                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetInstanceResult:
+    """
+    > **Important:**  The data source `observability.Cockpit` has been deprecated and will no longer be supported. Instead, use resource `observability.Cockpit`.
+
+    > **Note:**
+    As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
+    If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized data sources.
+
+    The `observability.Cockpit` data source is used to retrieve information about a Scaleway Cockpit associated with a given Project. This can be the default Project or a specific Project identified by its ID.
+
+    Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
+
+    ## Retrieve a Cockpit
+
+    The following commands allow you to:
+
+    - get information on the Cockpit associated with your Scaleway default Project
+    - get information on the Cockpit associated with a specific Scaleway Project
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    # Get the default Project's Cockpit
+    main = scaleway.observability.get_instance()
+    ```
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    # Get a specific Project's Cockpit
+    main = scaleway.observability.get_instance(project_id="11111111-1111-1111-1111-111111111111")
+    ```
+
+
+    :param str project_id: Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the Project ID specified in the provider configuration.
+    """
+    __args__ = dict()
+    __args__['projectId'] = project_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:observability/getInstance:getInstance', __args__, opts=opts, typ=GetInstanceResult).value
+
+    return AwaitableGetInstanceResult(
+        endpoints=pulumi.get(__ret__, 'endpoints'),
+        id=pulumi.get(__ret__, 'id'),
+        plan=pulumi.get(__ret__, 'plan'),
+        plan_id=pulumi.get(__ret__, 'plan_id'),
+        project_id=pulumi.get(__ret__, 'project_id'),
+        push_urls=pulumi.get(__ret__, 'push_urls'))
+def get_instance_output(project_id: Optional[pulumi.Input[Optional[str]]] = None,
+                        opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetInstanceResult]:
+    """
+    > **Important:**  The data source `observability.Cockpit` has been deprecated and will no longer be supported. Instead, use resource `observability.Cockpit`.
+
+    > **Note:**
+    As of April 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
+    If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized data sources.
+
+    The `observability.Cockpit` data source is used to retrieve information about a Scaleway Cockpit associated with a given Project. This can be the default Project or a specific Project identified by its ID.
+
+    Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
+
+    ## Retrieve a Cockpit
+
+    The following commands allow you to:
+
+    - get information on the Cockpit associated with your Scaleway default Project
+    - get information on the Cockpit associated with a specific Scaleway Project
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    # Get the default Project's Cockpit
+    main = scaleway.observability.get_instance()
+    ```
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+
+    # Get a specific Project's Cockpit
+    main = scaleway.observability.get_instance(project_id="11111111-1111-1111-1111-111111111111")
+    ```
+
+
+    :param str project_id: Specifies the ID of the Scaleway Project that the Cockpit is associated with. If not specified, it defaults to the Project ID specified in the provider configuration.
+    """
+    __args__ = dict()
+    __args__['projectId'] = project_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:observability/getInstance:getInstance', __args__, opts=opts, typ=GetInstanceResult)
+    return __ret__.apply(lambda __response__: GetInstanceResult(
+        endpoints=pulumi.get(__response__, 'endpoints'),
+        id=pulumi.get(__response__, 'id'),
+        plan=pulumi.get(__response__, 'plan'),
+        plan_id=pulumi.get(__response__, 'plan_id'),
+        project_id=pulumi.get(__response__, 'project_id'),
+        push_urls=pulumi.get(__response__, 'push_urls')))

pulumiverse_scaleway/observability/get_plan.py

@@ -0,0 +1,125 @@
+# 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__ = [
+    'GetPlanResult',
+    'AwaitableGetPlanResult',
+    'get_plan',
+    'get_plan_output',
+]
+
+@pulumi.output_type
+class GetPlanResult:
+    """
+    A collection of values returned by getPlan.
+    """
+    def __init__(__self__, id=None, name=None):
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        return pulumi.get(self, "name")
+
+
+class AwaitableGetPlanResult(GetPlanResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetPlanResult(
+            id=self.id,
+            name=self.name)
+
+
+def get_plan(name: Optional[str] = None,
+             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPlanResult:
+    """
+    The `observability_get_plan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `observability.Cockpit`.
+
+    Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
+
+    Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
+
+    ## Fetch and associate a pricing plan to a Cockpit
+
+    The following command shows how to fetch information about the `premium` pricing plan and how to associate it with the Cockpit of your Scaleway default Project.
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    premium = scaleway.observability.get_plan(name="premium")
+    main = scaleway.observability.Cockpit("main", plan=premium.id)
+    ```
+
+
+    :param str name: Name of the pricing plan you want to retrieve information about.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scaleway:observability/getPlan:getPlan', __args__, opts=opts, typ=GetPlanResult).value
+
+    return AwaitableGetPlanResult(
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'))
+def get_plan_output(name: Optional[pulumi.Input[str]] = None,
+                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetPlanResult]:
+    """
+    The `observability_get_plan` data source is used to fetch details about a specific Scaleway Cockpit pricing plan. This information can then be used to configure resources like `observability.Cockpit`.
+
+    Find out more about [pricing plans](https://console.scaleway.com/cockpit/plans) in the Scaleway console.
+
+    Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
+
+    ## Fetch and associate a pricing plan to a Cockpit
+
+    The following command shows how to fetch information about the `premium` pricing plan and how to associate it with the Cockpit of your Scaleway default Project.
+
+    ```python
+    import pulumi
+    import pulumi_scaleway as scaleway
+    import pulumiverse_scaleway as scaleway
+
+    premium = scaleway.observability.get_plan(name="premium")
+    main = scaleway.observability.Cockpit("main", plan=premium.id)
+    ```
+
+
+    :param str name: Name of the pricing plan you want to retrieve information about.
+    """
+    __args__ = dict()
+    __args__['name'] = name
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scaleway:observability/getPlan:getPlan', __args__, opts=opts, typ=GetPlanResult)
+    return __ret__.apply(lambda __response__: GetPlanResult(
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name')))