@pulumi/opsgenie
Version:
A Pulumi package for creating and managing opsgenie cloud resources.
182 lines (181 loc) • 6.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manages an Incident Template within Opsgenie.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opsgenie from "@pulumi/opsgenie";
*
* const test = new opsgenie.Team("test", {
* name: "genietest-team",
* description: "This team deals with all the things",
* });
* const testService = new opsgenie.Service("test", {
* name: "genietest-service",
* teamId: test.id,
* });
* const testIncidentTemplate = new opsgenie.IncidentTemplate("test", {
* name: "genietest-incident-template",
* message: "Incident Message",
* priority: "P2",
* stakeholderProperties: [{
* enable: true,
* message: "Stakeholder Message",
* description: "Stakeholder Description",
* }],
* tags: [
* "tag1",
* "tag2",
* ],
* description: "Incident Description",
* details: {
* key1: "value1",
* key2: "value2",
* },
* impactedServices: [testService.id],
* });
* ```
*
* ## Import
*
* Service can be imported using the `template_id`, e.g.
*
* ```sh
* $ pulumi import opsgenie:index/incidentTemplate:IncidentTemplate test template_id`
* ```
*/
export declare class IncidentTemplate extends pulumi.CustomResource {
/**
* Get an existing IncidentTemplate 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?: IncidentTemplateState, opts?: pulumi.CustomResourceOptions): IncidentTemplate;
/**
* Returns true if the given object is an instance of IncidentTemplate. 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 IncidentTemplate;
/**
* Description field of the incident template. This field must not be longer than 10000 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Map of key-value pairs to use as custom properties of the incident template. This field must not be longer than 8000 characters.
*/
readonly details: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly impactedServices: pulumi.Output<string[] | undefined>;
/**
* Message of the related incident template. This field must not be longer than 130 characters.
*/
readonly message: pulumi.Output<string>;
/**
* Name of the incident template.
*/
readonly name: pulumi.Output<string>;
/**
* Priority level of the incident. Possible values are `P1`, `P2`, `P3`, `P4` and `P5`.
*
* * `impactedServices` (Optional) Impacted services of incident template. Maximum 20 services.
*
* * `stakeholderProperties` (Required)
*/
readonly priority: pulumi.Output<string>;
readonly stakeholderProperties: pulumi.Output<outputs.IncidentTemplateStakeholderProperty[]>;
/**
* Tags of the incident template.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a IncidentTemplate 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: IncidentTemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IncidentTemplate resources.
*/
export interface IncidentTemplateState {
/**
* Description field of the incident template. This field must not be longer than 10000 characters.
*/
description?: pulumi.Input<string>;
/**
* Map of key-value pairs to use as custom properties of the incident template. This field must not be longer than 8000 characters.
*/
details?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
impactedServices?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Message of the related incident template. This field must not be longer than 130 characters.
*/
message?: pulumi.Input<string>;
/**
* Name of the incident template.
*/
name?: pulumi.Input<string>;
/**
* Priority level of the incident. Possible values are `P1`, `P2`, `P3`, `P4` and `P5`.
*
* * `impactedServices` (Optional) Impacted services of incident template. Maximum 20 services.
*
* * `stakeholderProperties` (Required)
*/
priority?: pulumi.Input<string>;
stakeholderProperties?: pulumi.Input<pulumi.Input<inputs.IncidentTemplateStakeholderProperty>[]>;
/**
* Tags of the incident template.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a IncidentTemplate resource.
*/
export interface IncidentTemplateArgs {
/**
* Description field of the incident template. This field must not be longer than 10000 characters.
*/
description?: pulumi.Input<string>;
/**
* Map of key-value pairs to use as custom properties of the incident template. This field must not be longer than 8000 characters.
*/
details?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
impactedServices?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Message of the related incident template. This field must not be longer than 130 characters.
*/
message: pulumi.Input<string>;
/**
* Name of the incident template.
*/
name?: pulumi.Input<string>;
/**
* Priority level of the incident. Possible values are `P1`, `P2`, `P3`, `P4` and `P5`.
*
* * `impactedServices` (Optional) Impacted services of incident template. Maximum 20 services.
*
* * `stakeholderProperties` (Required)
*/
priority: pulumi.Input<string>;
stakeholderProperties: pulumi.Input<pulumi.Input<inputs.IncidentTemplateStakeholderProperty>[]>;
/**
* Tags of the incident template.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}