@pulumi/opsgenie
Version:
A Pulumi package for creating and managing opsgenie cloud resources.
178 lines (177 loc) • 5.78 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages heartbeat within Opsgenie.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opsgenie from "@pulumi/opsgenie";
*
* const test = new opsgenie.Heartbeat("test", {
* name: "genieheartbeat-test",
* description: "test opsgenie heartbeat terraform",
* intervalUnit: "minutes",
* interval: 10,
* enabled: false,
* alertMessage: "Test",
* alertPriority: "P3",
* alertTags: [
* "test",
* "fahri",
* ],
* ownerTeamId: testOpsgenieTeam.id,
* });
* ```
*
* ## Import
*
* Heartbeat Integrations can be imported using the `name`, e.g.
*
* ```sh
* $ pulumi import opsgenie:index/heartbeat:Heartbeat test name`
* ```
*/
export declare class Heartbeat extends pulumi.CustomResource {
/**
* Get an existing Heartbeat 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?: HeartbeatState, opts?: pulumi.CustomResourceOptions): Heartbeat;
/**
* Returns true if the given object is an instance of Heartbeat. 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 Heartbeat;
/**
* Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
*/
readonly alertMessage: pulumi.Output<string | undefined>;
/**
* Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
*/
readonly alertPriority: pulumi.Output<string | undefined>;
/**
* Specifies the alert tags for heartbeat expiration alert.
*/
readonly alertTags: pulumi.Output<string[] | undefined>;
/**
* An optional description of the heartbeat
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Enable/disable heartbeat monitoring.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Specifies how often a heartbeat message should be expected.
*/
readonly interval: pulumi.Output<number>;
/**
* Interval specified as minutes, hours or days.
*/
readonly intervalUnit: pulumi.Output<string>;
/**
* Name of the heartbeat
*/
readonly name: pulumi.Output<string>;
/**
* Owner team of the heartbeat.
*/
readonly ownerTeamId: pulumi.Output<string | undefined>;
/**
* Create a Heartbeat 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.
*/
constructor(name: string, args: HeartbeatArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Heartbeat resources.
*/
export interface HeartbeatState {
/**
* Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
*/
alertMessage?: pulumi.Input<string>;
/**
* Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
*/
alertPriority?: pulumi.Input<string>;
/**
* Specifies the alert tags for heartbeat expiration alert.
*/
alertTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* An optional description of the heartbeat
*/
description?: pulumi.Input<string>;
/**
* Enable/disable heartbeat monitoring.
*/
enabled?: pulumi.Input<boolean>;
/**
* Specifies how often a heartbeat message should be expected.
*/
interval?: pulumi.Input<number>;
/**
* Interval specified as minutes, hours or days.
*/
intervalUnit?: pulumi.Input<string>;
/**
* Name of the heartbeat
*/
name?: pulumi.Input<string>;
/**
* Owner team of the heartbeat.
*/
ownerTeamId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Heartbeat resource.
*/
export interface HeartbeatArgs {
/**
* Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
*/
alertMessage?: pulumi.Input<string>;
/**
* Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
*/
alertPriority?: pulumi.Input<string>;
/**
* Specifies the alert tags for heartbeat expiration alert.
*/
alertTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* An optional description of the heartbeat
*/
description?: pulumi.Input<string>;
/**
* Enable/disable heartbeat monitoring.
*/
enabled: pulumi.Input<boolean>;
/**
* Specifies how often a heartbeat message should be expected.
*/
interval: pulumi.Input<number>;
/**
* Interval specified as minutes, hours or days.
*/
intervalUnit: pulumi.Input<string>;
/**
* Name of the heartbeat
*/
name?: pulumi.Input<string>;
/**
* Owner team of the heartbeat.
*/
ownerTeamId?: pulumi.Input<string>;
}