@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
142 lines (141 loc) • 6.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* The `scaleway.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 `tfTestProject`
* - 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const project = new scaleway.account.Project("project", {name: "tf_test_project"});
* const alertManager = new scaleway.observability.AlertManager("alert_manager", {
* projectId: project.id,
* enableManagedAlerts: true,
* contactPoints: [
* {
* 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:index/cockpitAlertManager:CockpitAlertManager main fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/cockpitalertmanager.CockpitAlertManager has been deprecated in favor of scaleway.observability/alertmanager.AlertManager
*/
export declare class CockpitAlertManager extends pulumi.CustomResource {
/**
* Get an existing CockpitAlertManager resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CockpitAlertManagerState, opts?: pulumi.CustomResourceOptions): CockpitAlertManager;
/**
* Returns true if the given object is an instance of CockpitAlertManager. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CockpitAlertManager;
/**
* The URL of the alert manager.
*/
readonly alertManagerUrl: pulumi.Output<string>;
/**
* A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
*/
readonly contactPoints: pulumi.Output<outputs.CockpitAlertManagerContactPoint[] | undefined>;
/**
* Specifies whether the alert manager should be enabled. Defaults to true.
*/
readonly enableManagedAlerts: pulumi.Output<boolean | undefined>;
/**
* ) The ID of the Project the Cockpit is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
*/
readonly region: pulumi.Output<string>;
/**
* Create a CockpitAlertManager resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
/** @deprecated scaleway.index/cockpitalertmanager.CockpitAlertManager has been deprecated in favor of scaleway.observability/alertmanager.AlertManager */
constructor(name: string, args?: CockpitAlertManagerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CockpitAlertManager resources.
*/
export interface CockpitAlertManagerState {
/**
* The URL of the alert manager.
*/
alertManagerUrl?: pulumi.Input<string>;
/**
* A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
*/
contactPoints?: pulumi.Input<pulumi.Input<inputs.CockpitAlertManagerContactPoint>[]>;
/**
* Specifies whether the alert manager should be enabled. Defaults to true.
*/
enableManagedAlerts?: pulumi.Input<boolean>;
/**
* ) The ID of the Project the Cockpit is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CockpitAlertManager resource.
*/
export interface CockpitAlertManagerArgs {
/**
* A list of contact points with email addresses that will receive alerts. Each map should contain a single key email.
*/
contactPoints?: pulumi.Input<pulumi.Input<inputs.CockpitAlertManagerContactPoint>[]>;
/**
* Specifies whether the alert manager should be enabled. Defaults to true.
*/
enableManagedAlerts?: pulumi.Input<boolean>;
/**
* ) The ID of the Project the Cockpit is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* ) The region where the [alert manager](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#alert-manager) should be enabled.
*/
region?: pulumi.Input<string>;
}