import * as pulumi from "@pulumi/pulumi"; /** * 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 `incidentTypeId` and `fieldId`, e.g. * * ```sh * $ pulumi import pagerduty:index/incidentTypeCustomField:IncidentTypeCustomField cs_impact PT1234:PF1234 * ``` */ export declare 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: string, id: pulumi.Input, state?: IncidentTypeCustomFieldState, opts?: pulumi.CustomResourceOptions): IncidentTypeCustomField; /** * 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: any): obj is IncidentTypeCustomField; /** * [Updating causes resource replacement] The type of the data of this custom field. Can be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url` when `dataType` is `singleValue`, otherwise must be `string`. Update */ readonly dataType: pulumi.Output; /** * The default value to set when new incidents are created. Always specified as a string. */ readonly defaultValue: pulumi.Output; /** * The description of the custom field. */ readonly description: pulumi.Output; /** * The display name of the custom Type. */ readonly displayName: pulumi.Output; /** * Whether the custom field is enabled. Defaults to true if not provided. */ readonly enabled: pulumi.Output; /** * The options for the custom field. Can only be applied to fields with a type of `singleValueFixed` or `multiValueFixed`. */ readonly fieldOptions: pulumi.Output; /** * [Updating causes resource replacement] The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`. */ readonly fieldType: pulumi.Output; /** * [Updating causes resource replacement] The id of the incident type the custom field is associated with. */ readonly incidentType: pulumi.Output; /** * [Updating causes resource replacement] The name of the custom field. */ readonly name: pulumi.Output; /** * The API show URL at which the object is accessible. */ readonly self: pulumi.Output; /** * A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier. */ readonly summary: pulumi.Output; readonly type: pulumi.Output; /** * Create a IncidentTypeCustomField 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: IncidentTypeCustomFieldArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IncidentTypeCustomField resources. */ export interface IncidentTypeCustomFieldState { /** * [Updating causes resource replacement] The type of the data of this custom field. Can be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url` when `dataType` is `singleValue`, otherwise must be `string`. Update */ dataType?: pulumi.Input; /** * The default value to set when new incidents are created. Always specified as a string. */ defaultValue?: pulumi.Input; /** * The description of the custom field. */ description?: pulumi.Input; /** * The display name of the custom Type. */ displayName?: pulumi.Input; /** * Whether the custom field is enabled. Defaults to true if not provided. */ enabled?: pulumi.Input; /** * The options for the custom field. Can only be applied to fields with a type of `singleValueFixed` or `multiValueFixed`. */ fieldOptions?: pulumi.Input[] | undefined>; /** * [Updating causes resource replacement] The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`. */ fieldType?: pulumi.Input; /** * [Updating causes resource replacement] The id of the incident type the custom field is associated with. */ incidentType?: pulumi.Input; /** * [Updating causes resource replacement] The name of the custom field. */ name?: pulumi.Input; /** * The API show URL at which the object is accessible. */ self?: pulumi.Input; /** * A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier. */ summary?: pulumi.Input; type?: pulumi.Input; } /** * The set of arguments for constructing a IncidentTypeCustomField resource. */ export interface IncidentTypeCustomFieldArgs { /** * [Updating causes resource replacement] The type of the data of this custom field. Can be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url` when `dataType` is `singleValue`, otherwise must be `string`. Update */ dataType: pulumi.Input; /** * The default value to set when new incidents are created. Always specified as a string. */ defaultValue?: pulumi.Input; /** * The description of the custom field. */ description?: pulumi.Input; /** * The display name of the custom Type. */ displayName: pulumi.Input; /** * Whether the custom field is enabled. Defaults to true if not provided. */ enabled?: pulumi.Input; /** * The options for the custom field. Can only be applied to fields with a type of `singleValueFixed` or `multiValueFixed`. */ fieldOptions?: pulumi.Input[] | undefined>; /** * [Updating causes resource replacement] The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`. */ fieldType?: pulumi.Input; /** * [Updating causes resource replacement] The id of the incident type the custom field is associated with. */ incidentType: pulumi.Input; /** * [Updating causes resource replacement] The name of the custom field. */ name?: pulumi.Input; } //# sourceMappingURL=incidentTypeCustomField.d.ts.map