pulumiverse-scaleway 1.25.0a1742288097__py3-none-any.whl → 1.25.0a1742668904__py3-none-any.whl

pulumiverse_scaleway/observability/alert_manager.py

@@ -0,0 +1,403 @@
+# 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__ = ['AlertManagerArgs', 'AlertManager']
+
+@pulumi.input_type
+class AlertManagerArgs:
+    def __init__(__self__, *,
+                 contact_points: Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]] = None,
+                 enable_managed_alerts: Optional[pulumi.Input[bool]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None):
+        """
+        The set of arguments for constructing a AlertManager resource.
+        :param pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]] contact_points: A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        :param pulumi.Input[bool] enable_managed_alerts: Specifies whether the alert manager should be enabled. Defaults to true.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[str] region: ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        if contact_points is not None:
+            pulumi.set(__self__, "contact_points", contact_points)
+        if enable_managed_alerts is not None:
+            pulumi.set(__self__, "enable_managed_alerts", enable_managed_alerts)
+        if project_id is not None:
+            pulumi.set(__self__, "project_id", project_id)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+
+    @property
+    @pulumi.getter(name="contactPoints")
+    def contact_points(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]]:
+        """
+        A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        """
+        return pulumi.get(self, "contact_points")
+
+    @contact_points.setter
+    def contact_points(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]]):
+        pulumi.set(self, "contact_points", value)
+
+    @property
+    @pulumi.getter(name="enableManagedAlerts")
+    def enable_managed_alerts(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Specifies whether the alert manager should be enabled. Defaults to true.
+        """
+        return pulumi.get(self, "enable_managed_alerts")
+
+    @enable_managed_alerts.setter
+    def enable_managed_alerts(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "enable_managed_alerts", 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
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+
+@pulumi.input_type
+class _AlertManagerState:
+    def __init__(__self__, *,
+                 alert_manager_url: Optional[pulumi.Input[str]] = None,
+                 contact_points: Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]] = None,
+                 enable_managed_alerts: Optional[pulumi.Input[bool]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering AlertManager resources.
+        :param pulumi.Input[str] alert_manager_url: The URL of the alert manager.
+        :param pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]] contact_points: A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        :param pulumi.Input[bool] enable_managed_alerts: Specifies whether the alert manager should be enabled. Defaults to true.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[str] region: ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        if alert_manager_url is not None:
+            pulumi.set(__self__, "alert_manager_url", alert_manager_url)
+        if contact_points is not None:
+            pulumi.set(__self__, "contact_points", contact_points)
+        if enable_managed_alerts is not None:
+            pulumi.set(__self__, "enable_managed_alerts", enable_managed_alerts)
+        if project_id is not None:
+            pulumi.set(__self__, "project_id", project_id)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+
+    @property
+    @pulumi.getter(name="alertManagerUrl")
+    def alert_manager_url(self) -> Optional[pulumi.Input[str]]:
+        """
+        The URL of the alert manager.
+        """
+        return pulumi.get(self, "alert_manager_url")
+
+    @alert_manager_url.setter
+    def alert_manager_url(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "alert_manager_url", value)
+
+    @property
+    @pulumi.getter(name="contactPoints")
+    def contact_points(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]]:
+        """
+        A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        """
+        return pulumi.get(self, "contact_points")
+
+    @contact_points.setter
+    def contact_points(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['AlertManagerContactPointArgs']]]]):
+        pulumi.set(self, "contact_points", value)
+
+    @property
+    @pulumi.getter(name="enableManagedAlerts")
+    def enable_managed_alerts(self) -> Optional[pulumi.Input[bool]]:
+        """
+        Specifies whether the alert manager should be enabled. Defaults to true.
+        """
+        return pulumi.get(self, "enable_managed_alerts")
+
+    @enable_managed_alerts.setter
+    def enable_managed_alerts(self, value: Optional[pulumi.Input[bool]]):
+        pulumi.set(self, "enable_managed_alerts", 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
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+
+class AlertManager(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 contact_points: Optional[pulumi.Input[Sequence[pulumi.Input[Union['AlertManagerContactPointArgs', 'AlertManagerContactPointArgsDict']]]]] = None,
+                 enable_managed_alerts: Optional[pulumi.Input[bool]] = None,
+                 project_id: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        The `observability.AlertManager` resource allows you to enable and manage the Scaleway Cockpit [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager).
+
+        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.
+
+        ## Example Usage
+
+        ### Enable the alert manager and configure managed alerts
+
+        The following commands allow you to:
+
+        - enable the alert manager in a Project named `tf_test_project`
+        - enable [managed alerts](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#managed-alerts)
+        - set up [contact points](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#contact-points) to receive alert notifications
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        project = scaleway.account.Project("project", name="tf_test_project")
+        alert_manager = scaleway.observability.AlertManager("alert_manager",
+            project_id=project.id,
+            enable_managed_alerts=True,
+            contact_points=[
+                {
+                    "email": "alert1@example.com",
+                },
+                {
+                    "email": "alert2@example.com",
+                },
+            ])
+        ```
+
+        ## Import
+
+        This section explains how to import alert managers using the ID of the Project associated with Cockpit.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:observability/alertManager:AlertManager 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[Sequence[pulumi.Input[Union['AlertManagerContactPointArgs', 'AlertManagerContactPointArgsDict']]]] contact_points: A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        :param pulumi.Input[bool] enable_managed_alerts: Specifies whether the alert manager should be enabled. Defaults to true.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[str] region: ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[AlertManagerArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        The `observability.AlertManager` resource allows you to enable and manage the Scaleway Cockpit [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager).
+
+        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.
+
+        ## Example Usage
+
+        ### Enable the alert manager and configure managed alerts
+
+        The following commands allow you to:
+
+        - enable the alert manager in a Project named `tf_test_project`
+        - enable [managed alerts](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#managed-alerts)
+        - set up [contact points](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#contact-points) to receive alert notifications
+
+        ```python
+        import pulumi
+        import pulumiverse_scaleway as scaleway
+
+        project = scaleway.account.Project("project", name="tf_test_project")
+        alert_manager = scaleway.observability.AlertManager("alert_manager",
+            project_id=project.id,
+            enable_managed_alerts=True,
+            contact_points=[
+                {
+                    "email": "alert1@example.com",
+                },
+                {
+                    "email": "alert2@example.com",
+                },
+            ])
+        ```
+
+        ## Import
+
+        This section explains how to import alert managers using the ID of the Project associated with Cockpit.
+
+        bash
+
+        ```sh
+        $ pulumi import scaleway:observability/alertManager:AlertManager main fr-par/11111111-1111-1111-1111-111111111111
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param AlertManagerArgs 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(AlertManagerArgs, 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,
+                 contact_points: Optional[pulumi.Input[Sequence[pulumi.Input[Union['AlertManagerContactPointArgs', 'AlertManagerContactPointArgsDict']]]]] = None,
+                 enable_managed_alerts: Optional[pulumi.Input[bool]] = None,
+                 project_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__ = AlertManagerArgs.__new__(AlertManagerArgs)
+
+            __props__.__dict__["contact_points"] = contact_points
+            __props__.__dict__["enable_managed_alerts"] = enable_managed_alerts
+            __props__.__dict__["project_id"] = project_id
+            __props__.__dict__["region"] = region
+            __props__.__dict__["alert_manager_url"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="scaleway:index/cockpitAlertManager:CockpitAlertManager")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(AlertManager, __self__).__init__(
+            'scaleway:observability/alertManager:AlertManager',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            alert_manager_url: Optional[pulumi.Input[str]] = None,
+            contact_points: Optional[pulumi.Input[Sequence[pulumi.Input[Union['AlertManagerContactPointArgs', 'AlertManagerContactPointArgsDict']]]]] = None,
+            enable_managed_alerts: Optional[pulumi.Input[bool]] = None,
+            project_id: Optional[pulumi.Input[str]] = None,
+            region: Optional[pulumi.Input[str]] = None) -> 'AlertManager':
+        """
+        Get an existing AlertManager 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] alert_manager_url: The URL of the alert manager.
+        :param pulumi.Input[Sequence[pulumi.Input[Union['AlertManagerContactPointArgs', 'AlertManagerContactPointArgsDict']]]] contact_points: A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        :param pulumi.Input[bool] enable_managed_alerts: Specifies whether the alert manager should be enabled. Defaults to true.
+        :param pulumi.Input[str] project_id: ) The ID of the Project the Cockpit is associated with.
+        :param pulumi.Input[str] region: ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _AlertManagerState.__new__(_AlertManagerState)
+
+        __props__.__dict__["alert_manager_url"] = alert_manager_url
+        __props__.__dict__["contact_points"] = contact_points
+        __props__.__dict__["enable_managed_alerts"] = enable_managed_alerts
+        __props__.__dict__["project_id"] = project_id
+        __props__.__dict__["region"] = region
+        return AlertManager(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="alertManagerUrl")
+    def alert_manager_url(self) -> pulumi.Output[str]:
+        """
+        The URL of the alert manager.
+        """
+        return pulumi.get(self, "alert_manager_url")
+
+    @property
+    @pulumi.getter(name="contactPoints")
+    def contact_points(self) -> pulumi.Output[Optional[Sequence['outputs.AlertManagerContactPoint']]]:
+        """
+        A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
+        """
+        return pulumi.get(self, "contact_points")
+
+    @property
+    @pulumi.getter(name="enableManagedAlerts")
+    def enable_managed_alerts(self) -> pulumi.Output[Optional[bool]]:
+        """
+        Specifies whether the alert manager should be enabled. Defaults to true.
+        """
+        return pulumi.get(self, "enable_managed_alerts")
+
+    @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
+    def region(self) -> pulumi.Output[str]:
+        """
+        ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
+        """
+        return pulumi.get(self, "region")
+