@pulumi/pagerduty/incidentCustomField.d.ts

A Pulumi package for creating and managing pagerduty cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * An [Incident Custom Field](https://support.pagerduty.com/docs/custom-fields-on-incidents) defines a field which can be set on incidents in the target account.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pagerduty from "@pulumi/pagerduty";
 *
 * const csImpact = new pagerduty.IncidentCustomField("cs_impact", {
 *     name: "impact",
 *     displayName: "Customer Impact",
 *     dataType: "string",
 *     fieldType: "single_value",
 * });
 * const sreEnvironment = new pagerduty.IncidentCustomField("sre_environment", {
 *     name: "environment",
 *     displayName: "Environment",
 *     dataType: "string",
 *     fieldType: "single_value_fixed",
 * });
 * const falseAlarm = new pagerduty.IncidentCustomField("false_alarm", {
 *     name: "false_alarm",
 *     displayName: "False Alarm",
 *     dataType: "boolean",
 *     fieldType: "single_value",
 *     defaultValue: "false",
 * });
 * ```
 *
 * ## Import
 *
 * Fields can be imported using the `id`, e.g.
 *
 * ```sh
 * $ pulumi import pagerduty:index/incidentCustomField:IncidentCustomField sre_environment PLBP09X
 * ```
 */
export declare class IncidentCustomField extends pulumi.CustomResource {
    /**
     * Get an existing IncidentCustomField 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?: IncidentCustomFieldState, opts?: pulumi.CustomResourceOptions): IncidentCustomField;
    /**
     * Returns true if the given object is an instance of IncidentCustomField.  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 IncidentCustomField;
    /**
     * The data type of the field. Must be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url`.
     */
    readonly dataType: pulumi.Output<string>;
    /**
     * The default value to set when new incidents are created. Always specified as a string.
     */
    readonly defaultValue: pulumi.Output<string | undefined>;
    /**
     * The description of the field.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The display name of the field.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`.
     */
    readonly fieldType: pulumi.Output<string>;
    /**
     * The name of the field.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Create a IncidentCustomField 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: IncidentCustomFieldArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IncidentCustomField resources.
 */
export interface IncidentCustomFieldState {
    /**
     * The data type of the field. Must be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url`.
     */
    dataType?: pulumi.Input<string>;
    /**
     * The default value to set when new incidents are created. Always specified as a string.
     */
    defaultValue?: pulumi.Input<string>;
    /**
     * The description of the field.
     */
    description?: pulumi.Input<string>;
    /**
     * The display name of the field.
     */
    displayName?: pulumi.Input<string>;
    /**
     * The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`.
     */
    fieldType?: pulumi.Input<string>;
    /**
     * The name of the field.
     */
    name?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IncidentCustomField resource.
 */
export interface IncidentCustomFieldArgs {
    /**
     * The data type of the field. Must be one of `string`, `integer`, `float`, `boolean`, `datetime`, or `url`.
     */
    dataType: pulumi.Input<string>;
    /**
     * The default value to set when new incidents are created. Always specified as a string.
     */
    defaultValue?: pulumi.Input<string>;
    /**
     * The description of the field.
     */
    description?: pulumi.Input<string>;
    /**
     * The display name of the field.
     */
    displayName: pulumi.Input<string>;
    /**
     * The field type of the field. Must be one of `singleValue`, `singleValueFixed`, `multiValue`, or `multiValueFixed`.
     */
    fieldType: pulumi.Input<string>;
    /**
     * The name of the field.
     */
    name?: pulumi.Input<string>;
}