1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. IncidentTypeCustomField
PagerDuty v4.22.1 published on Friday, Mar 21, 2025 by Pulumi

pagerduty.IncidentTypeCustomField

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.22.1 published on Friday, Mar 21, 2025 by Pulumi

    An incident type custom fields 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

    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 pulumi
    import json
    import pulumi_pagerduty as pagerduty
    
    alarm_time = pagerduty.IncidentTypeCustomField("alarm_time",
        name="alarm_time_minutes",
        display_name="Alarm Time",
        data_type="integer",
        field_type="single_value",
        default_value=json.dumps(5),
        incident_type="incident_default")
    foo = pagerduty.get_incident_type(display_name="Foo")
    level = pagerduty.IncidentTypeCustomField("level",
        name="level",
        incident_type=foo.id,
        display_name="Level",
        data_type="string",
        field_type="single_value_fixed",
        field_options=[
            "Trace",
            "Debug",
            "Info",
            "Warn",
            "Error",
            "Fatal",
        ])
    cs_impact = pagerduty.IncidentTypeCustomField("cs_impact",
        name="impact",
        incident_type=foo.id,
        display_name="Customer Impact",
        data_type="string",
        field_type="multi_value")
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(5)
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = pagerduty.NewIncidentTypeCustomField(ctx, "alarm_time", &pagerduty.IncidentTypeCustomFieldArgs{
    			Name:         pulumi.String("alarm_time_minutes"),
    			DisplayName:  pulumi.String("Alarm Time"),
    			DataType:     pulumi.String("integer"),
    			FieldType:    pulumi.String("single_value"),
    			DefaultValue: pulumi.String(json0),
    			IncidentType: pulumi.String("incident_default"),
    		})
    		if err != nil {
    			return err
    		}
    		foo, err := pagerduty.LookupIncidentType(ctx, &pagerduty.LookupIncidentTypeArgs{
    			DisplayName: "Foo",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = pagerduty.NewIncidentTypeCustomField(ctx, "level", &pagerduty.IncidentTypeCustomFieldArgs{
    			Name:         pulumi.String("level"),
    			IncidentType: pulumi.String(foo.Id),
    			DisplayName:  pulumi.String("Level"),
    			DataType:     pulumi.String("string"),
    			FieldType:    pulumi.String("single_value_fixed"),
    			FieldOptions: pulumi.StringArray{
    				pulumi.String("Trace"),
    				pulumi.String("Debug"),
    				pulumi.String("Info"),
    				pulumi.String("Warn"),
    				pulumi.String("Error"),
    				pulumi.String("Fatal"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = pagerduty.NewIncidentTypeCustomField(ctx, "cs_impact", &pagerduty.IncidentTypeCustomFieldArgs{
    			Name:         pulumi.String("impact"),
    			IncidentType: pulumi.String(foo.Id),
    			DisplayName:  pulumi.String("Customer Impact"),
    			DataType:     pulumi.String("string"),
    			FieldType:    pulumi.String("multi_value"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Pagerduty = Pulumi.Pagerduty;
    
    return await Deployment.RunAsync(() => 
    {
        var alarmTime = new Pagerduty.IncidentTypeCustomField("alarm_time", new()
        {
            Name = "alarm_time_minutes",
            DisplayName = "Alarm Time",
            DataType = "integer",
            FieldType = "single_value",
            DefaultValue = JsonSerializer.Serialize(5),
            IncidentType = "incident_default",
        });
    
        var foo = Pagerduty.GetIncidentType.Invoke(new()
        {
            DisplayName = "Foo",
        });
    
        var level = new Pagerduty.IncidentTypeCustomField("level", new()
        {
            Name = "level",
            IncidentType = foo.Apply(getIncidentTypeResult => getIncidentTypeResult.Id),
            DisplayName = "Level",
            DataType = "string",
            FieldType = "single_value_fixed",
            FieldOptions = new[]
            {
                "Trace",
                "Debug",
                "Info",
                "Warn",
                "Error",
                "Fatal",
            },
        });
    
        var csImpact = new Pagerduty.IncidentTypeCustomField("cs_impact", new()
        {
            Name = "impact",
            IncidentType = foo.Apply(getIncidentTypeResult => getIncidentTypeResult.Id),
            DisplayName = "Customer Impact",
            DataType = "string",
            FieldType = "multi_value",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.pagerduty.IncidentTypeCustomField;
    import com.pulumi.pagerduty.IncidentTypeCustomFieldArgs;
    import com.pulumi.pagerduty.PagerdutyFunctions;
    import com.pulumi.pagerduty.inputs.GetIncidentTypeArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var alarmTime = new IncidentTypeCustomField("alarmTime", IncidentTypeCustomFieldArgs.builder()
                .name("alarm_time_minutes")
                .displayName("Alarm Time")
                .dataType("integer")
                .fieldType("single_value")
                .defaultValue(serializeJson(
                    5))
                .incidentType("incident_default")
                .build());
    
            final var foo = PagerdutyFunctions.getIncidentType(GetIncidentTypeArgs.builder()
                .displayName("Foo")
                .build());
    
            var level = new IncidentTypeCustomField("level", IncidentTypeCustomFieldArgs.builder()
                .name("level")
                .incidentType(foo.applyValue(getIncidentTypeResult -> getIncidentTypeResult.id()))
                .displayName("Level")
                .dataType("string")
                .fieldType("single_value_fixed")
                .fieldOptions(            
                    "Trace",
                    "Debug",
                    "Info",
                    "Warn",
                    "Error",
                    "Fatal")
                .build());
    
            var csImpact = new IncidentTypeCustomField("csImpact", IncidentTypeCustomFieldArgs.builder()
                .name("impact")
                .incidentType(foo.applyValue(getIncidentTypeResult -> getIncidentTypeResult.id()))
                .displayName("Customer Impact")
                .dataType("string")
                .fieldType("multi_value")
                .build());
    
        }
    }
    
    resources:
      alarmTime:
        type: pagerduty:IncidentTypeCustomField
        name: alarm_time
        properties:
          name: alarm_time_minutes
          displayName: Alarm Time
          dataType: integer
          fieldType: single_value
          defaultValue:
            fn::toJSON: 5
          incidentType: incident_default
      level:
        type: pagerduty:IncidentTypeCustomField
        properties:
          name: level
          incidentType: ${foo.id}
          displayName: Level
          dataType: string
          fieldType: single_value_fixed
          fieldOptions:
            - Trace
            - Debug
            - Info
            - Warn
            - Error
            - Fatal
      csImpact:
        type: pagerduty:IncidentTypeCustomField
        name: cs_impact
        properties:
          name: impact
          incidentType: ${foo.id}
          displayName: Customer Impact
          dataType: string
          fieldType: multi_value
    variables:
      foo:
        fn::invoke:
          function: pagerduty:getIncidentType
          arguments:
            displayName: Foo
    

    Create IncidentTypeCustomField Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IncidentTypeCustomField(name: string, args: IncidentTypeCustomFieldArgs, opts?: CustomResourceOptions);
    @overload
    def IncidentTypeCustomField(resource_name: str,
                                args: IncidentTypeCustomFieldArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def IncidentTypeCustomField(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                data_type: Optional[str] = None,
                                display_name: Optional[str] = None,
                                incident_type: Optional[str] = None,
                                default_value: Optional[str] = None,
                                description: Optional[str] = None,
                                enabled: Optional[bool] = None,
                                field_options: Optional[Sequence[str]] = None,
                                field_type: Optional[str] = None,
                                name: Optional[str] = None)
    func NewIncidentTypeCustomField(ctx *Context, name string, args IncidentTypeCustomFieldArgs, opts ...ResourceOption) (*IncidentTypeCustomField, error)
    public IncidentTypeCustomField(string name, IncidentTypeCustomFieldArgs args, CustomResourceOptions? opts = null)
    public IncidentTypeCustomField(String name, IncidentTypeCustomFieldArgs args)
    public IncidentTypeCustomField(String name, IncidentTypeCustomFieldArgs args, CustomResourceOptions options)
    
    type: pagerduty:IncidentTypeCustomField
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IncidentTypeCustomFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IncidentTypeCustomFieldArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IncidentTypeCustomFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IncidentTypeCustomFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IncidentTypeCustomFieldArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var incidentTypeCustomFieldResource = new Pagerduty.IncidentTypeCustomField("incidentTypeCustomFieldResource", new()
    {
        DataType = "string",
        DisplayName = "string",
        IncidentType = "string",
        DefaultValue = "string",
        Description = "string",
        Enabled = false,
        FieldOptions = new[]
        {
            "string",
        },
        FieldType = "string",
        Name = "string",
    });
    
    example, err := pagerduty.NewIncidentTypeCustomField(ctx, "incidentTypeCustomFieldResource", &pagerduty.IncidentTypeCustomFieldArgs{
    	DataType:     pulumi.String("string"),
    	DisplayName:  pulumi.String("string"),
    	IncidentType: pulumi.String("string"),
    	DefaultValue: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Enabled:      pulumi.Bool(false),
    	FieldOptions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	FieldType: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var incidentTypeCustomFieldResource = new IncidentTypeCustomField("incidentTypeCustomFieldResource", IncidentTypeCustomFieldArgs.builder()
        .dataType("string")
        .displayName("string")
        .incidentType("string")
        .defaultValue("string")
        .description("string")
        .enabled(false)
        .fieldOptions("string")
        .fieldType("string")
        .name("string")
        .build());
    
    incident_type_custom_field_resource = pagerduty.IncidentTypeCustomField("incidentTypeCustomFieldResource",
        data_type="string",
        display_name="string",
        incident_type="string",
        default_value="string",
        description="string",
        enabled=False,
        field_options=["string"],
        field_type="string",
        name="string")
    
    const incidentTypeCustomFieldResource = new pagerduty.IncidentTypeCustomField("incidentTypeCustomFieldResource", {
        dataType: "string",
        displayName: "string",
        incidentType: "string",
        defaultValue: "string",
        description: "string",
        enabled: false,
        fieldOptions: ["string"],
        fieldType: "string",
        name: "string",
    });
    
    type: pagerduty:IncidentTypeCustomField
    properties:
        dataType: string
        defaultValue: string
        description: string
        displayName: string
        enabled: false
        fieldOptions:
            - string
        fieldType: string
        incidentType: string
        name: string
    

    IncidentTypeCustomField Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IncidentTypeCustomField resource accepts the following input properties:

    DataType string
    [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 data_type is single_value, otherwise must be string. Update
    DisplayName string
    The display name of the custom Type.
    IncidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    DefaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    Description string
    The description of the custom field.
    Enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    FieldOptions List<string>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    FieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    Name string
    [Updating causes resource replacement] The name of the custom field.
    DataType string
    [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 data_type is single_value, otherwise must be string. Update
    DisplayName string
    The display name of the custom Type.
    IncidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    DefaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    Description string
    The description of the custom field.
    Enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    FieldOptions []string
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    FieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    Name string
    [Updating causes resource replacement] The name of the custom field.
    dataType String
    [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 data_type is single_value, otherwise must be string. Update
    displayName String
    The display name of the custom Type.
    incidentType String
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    defaultValue String
    The default value to set when new incidents are created. Always specified as a string.
    description String
    The description of the custom field.
    enabled Boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions List<String>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType String
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    name String
    [Updating causes resource replacement] The name of the custom field.
    dataType string
    [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 data_type is single_value, otherwise must be string. Update
    displayName string
    The display name of the custom Type.
    incidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    defaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    description string
    The description of the custom field.
    enabled boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions string[]
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    name string
    [Updating causes resource replacement] The name of the custom field.
    data_type str
    [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 data_type is single_value, otherwise must be string. Update
    display_name str
    The display name of the custom Type.
    incident_type str
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    default_value str
    The default value to set when new incidents are created. Always specified as a string.
    description str
    The description of the custom field.
    enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    field_options Sequence[str]
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    field_type str
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    name str
    [Updating causes resource replacement] The name of the custom field.
    dataType String
    [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 data_type is single_value, otherwise must be string. Update
    displayName String
    The display name of the custom Type.
    incidentType String
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    defaultValue String
    The default value to set when new incidents are created. Always specified as a string.
    description String
    The description of the custom field.
    enabled Boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions List<String>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType String
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    name String
    [Updating causes resource replacement] The name of the custom field.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IncidentTypeCustomField resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Self string
    The API show URL at which the object is accessible.
    Summary string
    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.
    Type string
    Id string
    The provider-assigned unique ID for this managed resource.
    Self string
    The API show URL at which the object is accessible.
    Summary string
    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.
    Type string
    id String
    The provider-assigned unique ID for this managed resource.
    self String
    The API show URL at which the object is accessible.
    summary String
    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.
    type String
    id string
    The provider-assigned unique ID for this managed resource.
    self string
    The API show URL at which the object is accessible.
    summary string
    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.
    type string
    id str
    The provider-assigned unique ID for this managed resource.
    self str
    The API show URL at which the object is accessible.
    summary str
    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.
    type str
    id String
    The provider-assigned unique ID for this managed resource.
    self String
    The API show URL at which the object is accessible.
    summary String
    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.
    type String

    Look up Existing IncidentTypeCustomField Resource

    Get an existing IncidentTypeCustomField resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IncidentTypeCustomFieldState, opts?: CustomResourceOptions): IncidentTypeCustomField
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data_type: Optional[str] = None,
            default_value: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            enabled: Optional[bool] = None,
            field_options: Optional[Sequence[str]] = None,
            field_type: Optional[str] = None,
            incident_type: Optional[str] = None,
            name: Optional[str] = None,
            self: Optional[str] = None,
            summary: Optional[str] = None,
            type: Optional[str] = None) -> IncidentTypeCustomField
    func GetIncidentTypeCustomField(ctx *Context, name string, id IDInput, state *IncidentTypeCustomFieldState, opts ...ResourceOption) (*IncidentTypeCustomField, error)
    public static IncidentTypeCustomField Get(string name, Input<string> id, IncidentTypeCustomFieldState? state, CustomResourceOptions? opts = null)
    public static IncidentTypeCustomField get(String name, Output<String> id, IncidentTypeCustomFieldState state, CustomResourceOptions options)
    resources:  _:    type: pagerduty:IncidentTypeCustomField    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataType string
    [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 data_type is single_value, otherwise must be string. Update
    DefaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    Description string
    The description of the custom field.
    DisplayName string
    The display name of the custom Type.
    Enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    FieldOptions List<string>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    FieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    IncidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    Name string
    [Updating causes resource replacement] The name of the custom field.
    Self string
    The API show URL at which the object is accessible.
    Summary string
    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.
    Type string
    DataType string
    [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 data_type is single_value, otherwise must be string. Update
    DefaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    Description string
    The description of the custom field.
    DisplayName string
    The display name of the custom Type.
    Enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    FieldOptions []string
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    FieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    IncidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    Name string
    [Updating causes resource replacement] The name of the custom field.
    Self string
    The API show URL at which the object is accessible.
    Summary string
    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.
    Type string
    dataType String
    [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 data_type is single_value, otherwise must be string. Update
    defaultValue String
    The default value to set when new incidents are created. Always specified as a string.
    description String
    The description of the custom field.
    displayName String
    The display name of the custom Type.
    enabled Boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions List<String>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType String
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    incidentType String
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    name String
    [Updating causes resource replacement] The name of the custom field.
    self String
    The API show URL at which the object is accessible.
    summary String
    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.
    type String
    dataType string
    [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 data_type is single_value, otherwise must be string. Update
    defaultValue string
    The default value to set when new incidents are created. Always specified as a string.
    description string
    The description of the custom field.
    displayName string
    The display name of the custom Type.
    enabled boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions string[]
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType string
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    incidentType string
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    name string
    [Updating causes resource replacement] The name of the custom field.
    self string
    The API show URL at which the object is accessible.
    summary string
    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.
    type string
    data_type str
    [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 data_type is single_value, otherwise must be string. Update
    default_value str
    The default value to set when new incidents are created. Always specified as a string.
    description str
    The description of the custom field.
    display_name str
    The display name of the custom Type.
    enabled bool
    Whether the custom field is enabled. Defaults to true if not provided.
    field_options Sequence[str]
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    field_type str
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    incident_type str
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    name str
    [Updating causes resource replacement] The name of the custom field.
    self str
    The API show URL at which the object is accessible.
    summary str
    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.
    type str
    dataType String
    [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 data_type is single_value, otherwise must be string. Update
    defaultValue String
    The default value to set when new incidents are created. Always specified as a string.
    description String
    The description of the custom field.
    displayName String
    The display name of the custom Type.
    enabled Boolean
    Whether the custom field is enabled. Defaults to true if not provided.
    fieldOptions List<String>
    The options for the custom field. Can only be applied to fields with a type of single_value_fixed or multi_value_fixed.
    fieldType String
    [Updating causes resource replacement] The field type of the field. Must be one of single_value, single_value_fixed, multi_value, or multi_value_fixed.
    incidentType String
    [Updating causes resource replacement] The id of the incident type the custom field is associated with.
    name String
    [Updating causes resource replacement] The name of the custom field.
    self String
    The API show URL at which the object is accessible.
    summary String
    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.
    type String

    Import

    Fields can be imported using the combination of incident_type_id and field_id, e.g.

    $ pulumi import pagerduty:index/incidentTypeCustomField:IncidentTypeCustomField cs_impact PT1234:PF1234
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.22.1 published on Friday, Mar 21, 2025 by Pulumi