@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
137 lines • 5.79 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.IncidentTypeCustomField = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* An [incident type custom fields](https://developer.pagerduty.com/api-reference/423b6701f3f1b-create-a-custom-field-for-an-incident-type)
* are a feature which will allow customers to extend Incidents with their own
* custom data, to provide additional context and support features such as
* customized filtering, search and analytics. Custom Fields can be applied to
* different incident types. Child types will inherit custom fields from their
* parent types.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const alarmTime = new pagerduty.IncidentTypeCustomField("alarm_time", {
* name: "alarm_time_minutes",
* displayName: "Alarm Time",
* dataType: "integer",
* fieldType: "single_value",
* defaultValue: JSON.stringify(5),
* incidentType: "incident_default",
* });
* const foo = pagerduty.getIncidentType({
* displayName: "Foo",
* });
* const level = new pagerduty.IncidentTypeCustomField("level", {
* name: "level",
* incidentType: foo.then(foo => foo.id),
* displayName: "Level",
* dataType: "string",
* fieldType: "single_value_fixed",
* fieldOptions: [
* "Trace",
* "Debug",
* "Info",
* "Warn",
* "Error",
* "Fatal",
* ],
* });
* const csImpact = new pagerduty.IncidentTypeCustomField("cs_impact", {
* name: "impact",
* incidentType: foo.then(foo => foo.id),
* displayName: "Customer Impact",
* dataType: "string",
* fieldType: "multi_value",
* });
* ```
*
* ## Import
*
* Fields can be imported using the combination of `incident_type_id` and `field_id`, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/incidentTypeCustomField:IncidentTypeCustomField cs_impact PT1234:PF1234
* ```
*/
class IncidentTypeCustomField extends pulumi.CustomResource {
/**
* Get an existing IncidentTypeCustomField 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, id, state, opts) {
return new IncidentTypeCustomField(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of IncidentTypeCustomField. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === IncidentTypeCustomField.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["dataType"] = state?.dataType;
resourceInputs["defaultValue"] = state?.defaultValue;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["enabled"] = state?.enabled;
resourceInputs["fieldOptions"] = state?.fieldOptions;
resourceInputs["fieldType"] = state?.fieldType;
resourceInputs["incidentType"] = state?.incidentType;
resourceInputs["name"] = state?.name;
resourceInputs["self"] = state?.self;
resourceInputs["summary"] = state?.summary;
resourceInputs["type"] = state?.type;
}
else {
const args = argsOrState;
if (args?.dataType === undefined && !opts.urn) {
throw new Error("Missing required property 'dataType'");
}
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
if (args?.incidentType === undefined && !opts.urn) {
throw new Error("Missing required property 'incidentType'");
}
resourceInputs["dataType"] = args?.dataType;
resourceInputs["defaultValue"] = args?.defaultValue;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["enabled"] = args?.enabled;
resourceInputs["fieldOptions"] = args?.fieldOptions;
resourceInputs["fieldType"] = args?.fieldType;
resourceInputs["incidentType"] = args?.incidentType;
resourceInputs["name"] = args?.name;
resourceInputs["self"] = undefined /*out*/;
resourceInputs["summary"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(IncidentTypeCustomField.__pulumiType, name, resourceInputs, opts);
}
}
exports.IncidentTypeCustomField = IncidentTypeCustomField;
/** @internal */
IncidentTypeCustomField.__pulumiType = 'pagerduty:index/incidentTypeCustomField:IncidentTypeCustomField';
//# sourceMappingURL=incidentTypeCustomField.js.map