@pulumi/opsgenie
Version:
A Pulumi package for creating and managing opsgenie cloud resources.
156 lines (155 loc) • 4.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages existing heartbeat within Opsgenie.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opsgenie from "@pulumi/opsgenie";
*
* const test = opsgenie.getHeartbeat({
* name: "genieheartbeat-existing",
* });
* ```
*/
export declare function getHeartbeat(args: GetHeartbeatArgs, opts?: pulumi.InvokeOptions): Promise<GetHeartbeatResult>;
/**
* A collection of arguments for invoking getHeartbeat.
*/
export interface GetHeartbeatArgs {
/**
* Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
*/
alertMessage?: string;
/**
* Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
*/
alertPriority?: string;
/**
* Specifies the alert tags for heartbeat expiration alert.
*/
alertTags?: string[];
/**
* An optional description of the heartbeat
*/
description?: string;
/**
* Enable/disable heartbeat monitoring.
*/
enabled?: boolean;
/**
* Specifies how often a heartbeat message should be expected.
*/
interval?: number;
/**
* Interval specified as minutes, hours or days.
*/
intervalUnit?: string;
/**
* Name of the heartbeat
*/
name: string;
/**
* Owner team of the heartbeat.
*/
ownerTeamId?: string;
}
/**
* A collection of values returned by getHeartbeat.
*/
export interface GetHeartbeatResult {
/**
* Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
*/
readonly alertMessage?: string;
/**
* Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
*/
readonly alertPriority?: string;
/**
* Specifies the alert tags for heartbeat expiration alert.
*/
readonly alertTags?: string[];
/**
* An optional description of the heartbeat
*/
readonly description?: string;
/**
* Enable/disable heartbeat monitoring.
*/
readonly enabled?: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Specifies how often a heartbeat message should be expected.
*/
readonly interval?: number;
/**
* Interval specified as minutes, hours or days.
*/
readonly intervalUnit?: string;
readonly name: string;
/**
* Owner team of the heartbeat.
*/
readonly ownerTeamId?: string;
}
/**
* Manages existing heartbeat within Opsgenie.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opsgenie from "@pulumi/opsgenie";
*
* const test = opsgenie.getHeartbeat({
* name: "genieheartbeat-existing",
* });
* ```
*/
export declare function getHeartbeatOutput(args: GetHeartbeatOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetHeartbeatResult>;
/**
* A collection of arguments for invoking getHeartbeat.
*/
export interface GetHeartbeatOutputArgs {
/**
* 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>;
}