@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
164 lines • 6.36 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.ServiceCustomField = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* A [service custom field](https://developer.pagerduty.com/api-reference/6075929031f7d-create-a-field)
* allows you to extend PagerDuty Services with custom data fields to provide
* additional context and support features such as customized filtering, search,
* and analytics.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* // Simple string field
* const environment = new pagerduty.ServiceCustomField("environment", {
* name: "environment",
* displayName: "Environment",
* dataType: "string",
* fieldType: "single_value",
* description: "The environment this service runs in",
* });
* // Field with fixed options
* const deploymentTier = new pagerduty.ServiceCustomField("deployment_tier", {
* name: "deployment_tier",
* displayName: "Deployment Tier",
* dataType: "string",
* fieldType: "single_value_fixed",
* description: "The deployment tier of the service",
* fieldOptions: [
* {
* value: "production",
* dataType: "string",
* },
* {
* value: "staging",
* dataType: "string",
* },
* {
* value: "development",
* dataType: "string",
* },
* ],
* });
* // Multi-value field with fixed options
* const regions = new pagerduty.ServiceCustomField("regions", {
* name: "regions",
* displayName: "AWS Regions",
* dataType: "string",
* fieldType: "multi_value_fixed",
* description: "AWS regions where this service is deployed",
* fieldOptions: [
* {
* value: "us-east-1",
* dataType: "string",
* },
* {
* value: "us-west-1",
* dataType: "string",
* },
* ],
* });
* // Boolean field
* const critical = new pagerduty.ServiceCustomField("critical", {
* name: "is_critical",
* displayName: "Is Critical",
* dataType: "boolean",
* fieldType: "single_value",
* description: "Whether this is a critical service",
* });
* // Integer field
* const priority = new pagerduty.ServiceCustomField("priority", {
* name: "priority_level",
* displayName: "Priority Level",
* dataType: "integer",
* fieldType: "single_value",
* description: "Service priority level",
* });
* ```
*
* ## Import
*
* Service custom fields can be imported using the field ID, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/serviceCustomField:ServiceCustomField example P123456
* ```
*/
class ServiceCustomField extends pulumi.CustomResource {
/**
* Get an existing ServiceCustomField 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 ServiceCustomField(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ServiceCustomField. 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'] === ServiceCustomField.__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["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?.fieldType === undefined && !opts.urn) {
throw new Error("Missing required property 'fieldType'");
}
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["name"] = args?.name;
resourceInputs["self"] = undefined /*out*/;
resourceInputs["summary"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ServiceCustomField.__pulumiType, name, resourceInputs, opts);
}
}
exports.ServiceCustomField = ServiceCustomField;
/** @internal */
ServiceCustomField.__pulumiType = 'pagerduty:index/serviceCustomField:ServiceCustomField';
//# sourceMappingURL=serviceCustomField.js.map