Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Datadog Provider
  4. API Docs
  5. IncidentUserDefinedField
Viewing docs for Datadog v5.9.0
published on Saturday, Jul 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.IncidentUserDefinedField

datadog logo
Viewing docs for Datadog v5.9.0
published on Saturday, Jul 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Provides a Datadog incident user-defined field resource. This can be used to create and manage custom fields on Datadog incidents. Note: This resource targets an endpoint that is in preview and is subject to change.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

const example = new datadog.IncidentType("example", {
    name: "Security Incident",
    description: "Security-related incidents requiring immediate attention",
});
// A dropdown user-defined field with a fixed set of valid values.
const exampleIncidentUserDefinedField = new datadog.IncidentUserDefinedField("example", {
    name: "root_cause",
    displayName: "Root Cause",
    type: "dropdown",
    category: "what_happened",
    defaultValue: "service_bug",
    incidentType: example.id,
    validValues: [
        {
            displayName: "Service Bug",
            value: "service_bug",
            description: "A bug in the service code.",
        },
        {
            displayName: "Human Error",
            value: "human_error",
        },
    ],
});

    import pulumi
import pulumi_datadog as datadog

example = datadog.IncidentType("example",
    name="Security Incident",
    description="Security-related incidents requiring immediate attention")
# A dropdown user-defined field with a fixed set of valid values.
example_incident_user_defined_field = datadog.IncidentUserDefinedField("example",
    name="root_cause",
    display_name="Root Cause",
    type="dropdown",
    category="what_happened",
    default_value="service_bug",
    incident_type=example.id,
    valid_values=[
        {
            "display_name": "Service Bug",
            "value": "service_bug",
            "description": "A bug in the service code.",
        },
        {
            "display_name": "Human Error",
            "value": "human_error",
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v5/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := datadog.NewIncidentType(ctx, "example", &datadog.IncidentTypeArgs{
			Name:        pulumi.String("Security Incident"),
			Description: pulumi.String("Security-related incidents requiring immediate attention"),
		})
		if err != nil {
			return err
		}
		// A dropdown user-defined field with a fixed set of valid values.
		_, err = datadog.NewIncidentUserDefinedField(ctx, "example", &datadog.IncidentUserDefinedFieldArgs{
			Name:         pulumi.String("root_cause"),
			DisplayName:  pulumi.String("Root Cause"),
			Type:         pulumi.String("dropdown"),
			Category:     pulumi.String("what_happened"),
			DefaultValue: pulumi.String("service_bug"),
			IncidentType: example.ID(),
			ValidValues: datadog.IncidentUserDefinedFieldValidValueArray{
				&datadog.IncidentUserDefinedFieldValidValueArgs{
					DisplayName: pulumi.String("Service Bug"),
					Value:       pulumi.String("service_bug"),
					Description: pulumi.String("A bug in the service code."),
				},
				&datadog.IncidentUserDefinedFieldValidValueArgs{
					DisplayName: pulumi.String("Human Error"),
					Value:       pulumi.String("human_error"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    var example = new Datadog.IncidentType("example", new()
    {
        Name = "Security Incident",
        Description = "Security-related incidents requiring immediate attention",
    });

    // A dropdown user-defined field with a fixed set of valid values.
    var exampleIncidentUserDefinedField = new Datadog.IncidentUserDefinedField("example", new()
    {
        Name = "root_cause",
        DisplayName = "Root Cause",
        Type = "dropdown",
        Category = "what_happened",
        DefaultValue = "service_bug",
        IncidentType = example.Id,
        ValidValues = new[]
        {
            new Datadog.Inputs.IncidentUserDefinedFieldValidValueArgs
            {
                DisplayName = "Service Bug",
                Value = "service_bug",
                Description = "A bug in the service code.",
            },
            new Datadog.Inputs.IncidentUserDefinedFieldValidValueArgs
            {
                DisplayName = "Human Error",
                Value = "human_error",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.IncidentType;
import com.pulumi.datadog.IncidentTypeArgs;
import com.pulumi.datadog.IncidentUserDefinedField;
import com.pulumi.datadog.IncidentUserDefinedFieldArgs;
import com.pulumi.datadog.inputs.IncidentUserDefinedFieldValidValueArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new IncidentType("example", IncidentTypeArgs.builder()
            .name("Security Incident")
            .description("Security-related incidents requiring immediate attention")
            .build());

        // A dropdown user-defined field with a fixed set of valid values.
        var exampleIncidentUserDefinedField = new IncidentUserDefinedField("exampleIncidentUserDefinedField", IncidentUserDefinedFieldArgs.builder()
            .name("root_cause")
            .displayName("Root Cause")
            .type("dropdown")
            .category("what_happened")
            .defaultValue("service_bug")
            .incidentType(example.id())
            .validValues(            
                IncidentUserDefinedFieldValidValueArgs.builder()
                    .displayName("Service Bug")
                    .value("service_bug")
                    .description("A bug in the service code.")
                    .build(),
                IncidentUserDefinedFieldValidValueArgs.builder()
                    .displayName("Human Error")
                    .value("human_error")
                    .build())
            .build());

    }
}

    resources:
  example:
    type: datadog:IncidentType
    properties:
      name: Security Incident
      description: Security-related incidents requiring immediate attention
  # A dropdown user-defined field with a fixed set of valid values.
  exampleIncidentUserDefinedField:
    type: datadog:IncidentUserDefinedField
    name: example
    properties:
      name: root_cause
      displayName: Root Cause
      type: dropdown
      category: what_happened
      defaultValue: service_bug
      incidentType: ${example.id}
      validValues:
        - displayName: Service Bug
          value: service_bug
          description: A bug in the service code.
        - displayName: Human Error
          value: human_error

    pulumi {
  required_providers {
    datadog = {
      source = "pulumi/datadog"
    }
  }
}

resource "datadog_incidenttype" "example" {
  name        = "Security Incident"
  description = "Security-related incidents requiring immediate attention"
}
# A dropdown user-defined field with a fixed set of valid values.
resource "datadog_incidentuserdefinedfield" "example" {
  name          = "root_cause"
  display_name  = "Root Cause"
  type          = "dropdown"
  category      = "what_happened"
  default_value = "service_bug"
  incident_type = datadog_incidenttype.example.id
  valid_values {
    display_name = "Service Bug"
    value        = "service_bug"
    description  = "A bug in the service code."
  }
  valid_values {
    display_name = "Human Error"
    value        = "human_error"
  }
}

    Create IncidentUserDefinedField Resource

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

    Constructor syntax

    new IncidentUserDefinedField(name: string, args: IncidentUserDefinedFieldArgs, opts?: CustomResourceOptions);
    @overload
def IncidentUserDefinedField(resource_name: str,
                             args: IncidentUserDefinedFieldArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def IncidentUserDefinedField(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             incident_type: Optional[str] = None,
                             name: Optional[str] = None,
                             type: Optional[str] = None,
                             category: Optional[str] = None,
                             default_value: Optional[str] = None,
                             display_name: Optional[str] = None,
                             ordinal: Optional[str] = None,
                             required: Optional[bool] = None,
                             tag_key: Optional[str] = None,
                             valid_values: Optional[Sequence[IncidentUserDefinedFieldValidValueArgs]] = None)
    func NewIncidentUserDefinedField(ctx *Context, name string, args IncidentUserDefinedFieldArgs, opts ...ResourceOption) (*IncidentUserDefinedField, error)
    public IncidentUserDefinedField(string name, IncidentUserDefinedFieldArgs args, CustomResourceOptions? opts = null)
    public IncidentUserDefinedField(String name, IncidentUserDefinedFieldArgs args)
public IncidentUserDefinedField(String name, IncidentUserDefinedFieldArgs args, CustomResourceOptions options)

    type: datadog:IncidentUserDefinedField
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "datadog_incident_user_defined_field" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IncidentUserDefinedFieldArgs
    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 IncidentUserDefinedFieldArgs
    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 IncidentUserDefinedFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IncidentUserDefinedFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IncidentUserDefinedFieldArgs
    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 incidentUserDefinedFieldResource = new Datadog.IncidentUserDefinedField("incidentUserDefinedFieldResource", new()
{
    IncidentType = "string",
    Name = "string",
    Type = "string",
    Category = "string",
    DefaultValue = "string",
    DisplayName = "string",
    Ordinal = "string",
    Required = false,
    TagKey = "string",
    ValidValues = new[]
    {
        new Datadog.Inputs.IncidentUserDefinedFieldValidValueArgs
        {
            DisplayName = "string",
            Value = "string",
            Description = "string",
            ShortDescription = "string",
        },
    },
});

    example, err := datadog.NewIncidentUserDefinedField(ctx, "incidentUserDefinedFieldResource", &datadog.IncidentUserDefinedFieldArgs{
	IncidentType: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Type:         pulumi.String("string"),
	Category:     pulumi.String("string"),
	DefaultValue: pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Ordinal:      pulumi.String("string"),
	Required:     pulumi.Bool(false),
	TagKey:       pulumi.String("string"),
	ValidValues: datadog.IncidentUserDefinedFieldValidValueArray{
		&datadog.IncidentUserDefinedFieldValidValueArgs{
			DisplayName:      pulumi.String("string"),
			Value:            pulumi.String("string"),
			Description:      pulumi.String("string"),
			ShortDescription: pulumi.String("string"),
		},
	},
})

    resource "datadog_incident_user_defined_field" "incidentUserDefinedFieldResource" {
  lifecycle {
    create_before_destroy = true
  }
  incident_type = "string"
  name          = "string"
  type          = "string"
  category      = "string"
  default_value = "string"
  display_name  = "string"
  ordinal       = "string"
  required      = false
  tag_key       = "string"
  valid_values {
    display_name      = "string"
    value             = "string"
    description       = "string"
    short_description = "string"
  }
}

    var incidentUserDefinedFieldResource = new IncidentUserDefinedField("incidentUserDefinedFieldResource", IncidentUserDefinedFieldArgs.builder()
    .incidentType("string")
    .name("string")
    .type("string")
    .category("string")
    .defaultValue("string")
    .displayName("string")
    .ordinal("string")
    .required(false)
    .tagKey("string")
    .validValues(IncidentUserDefinedFieldValidValueArgs.builder()
        .displayName("string")
        .value("string")
        .description("string")
        .shortDescription("string")
        .build())
    .build());

    incident_user_defined_field_resource = datadog.IncidentUserDefinedField("incidentUserDefinedFieldResource",
    incident_type="string",
    name="string",
    type="string",
    category="string",
    default_value="string",
    display_name="string",
    ordinal="string",
    required=False,
    tag_key="string",
    valid_values=[{
        "display_name": "string",
        "value": "string",
        "description": "string",
        "short_description": "string",
    }])

    const incidentUserDefinedFieldResource = new datadog.IncidentUserDefinedField("incidentUserDefinedFieldResource", {
    incidentType: "string",
    name: "string",
    type: "string",
    category: "string",
    defaultValue: "string",
    displayName: "string",
    ordinal: "string",
    required: false,
    tagKey: "string",
    validValues: [{
        displayName: "string",
        value: "string",
        description: "string",
        shortDescription: "string",
    }],
});

    type: datadog:IncidentUserDefinedField
properties:
    category: string
    defaultValue: string
    displayName: string
    incidentType: string
    name: string
    ordinal: string
    required: false
    tagKey: string
    type: string
    validValues:
        - description: string
          displayName: string
          shortDescription: string
          value: string

    IncidentUserDefinedField 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 IncidentUserDefinedField resource accepts the following input properties:

    IncidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    Name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    Type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    Category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    DefaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    DisplayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    Ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    Required bool
    When true, users must fill out this field on incidents. Defaults to false.
    TagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    ValidValues List<IncidentUserDefinedFieldValidValue>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    IncidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    Name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    Type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    Category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    DefaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    DisplayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    Ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    Required bool
    When true, users must fill out this field on incidents. Defaults to false.
    TagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    ValidValues []IncidentUserDefinedFieldValidValueArgs
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    incident_type string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    default_value string
    The default value for the field. Must be one of the valid values when validValues is set.
    display_name string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required bool
    When true, users must fill out this field on incidents. Defaults to false.
    tag_key string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    valid_values list(object)
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    incidentType String
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    name String
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    type String
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    category String
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    defaultValue String
    The default value for the field. Must be one of the valid values when validValues is set.
    displayName String
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    ordinal String
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required Boolean
    When true, users must fill out this field on incidents. Defaults to false.
    tagKey String
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    validValues List<IncidentUserDefinedFieldValidValue>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    incidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    defaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    displayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required boolean
    When true, users must fill out this field on incidents. Defaults to false.
    tagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    validValues IncidentUserDefinedFieldValidValue[]
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    incident_type str
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    name str
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    type str
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    category str
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    default_value str
    The default value for the field. Must be one of the valid values when validValues is set.
    display_name str
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    ordinal str
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required bool
    When true, users must fill out this field on incidents. Defaults to false.
    tag_key str
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    valid_values Sequence[IncidentUserDefinedFieldValidValueArgs]
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    incidentType String
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    name String
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    type String
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    category String
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    defaultValue String
    The default value for the field. Must be one of the valid values when validValues is set.
    displayName String
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    ordinal String
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required Boolean
    When true, users must fill out this field on incidents. Defaults to false.
    tagKey String
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    validValues List<Property Map>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.

    Outputs

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

    Created string
    Timestamp when the field was created.
    Deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    Modified string
    Timestamp when the field was last modified.
    Reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    Created string
    Timestamp when the field was created.
    Deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    Modified string
    Timestamp when the field was last modified.
    Reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    created string
    Timestamp when the field was created.
    deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    metadata object
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified string
    Timestamp when the field was last modified.
    reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    created String
    Timestamp when the field was created.
    deleted String
    Timestamp when the field was soft-deleted, or null if not deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified String
    Timestamp when the field was last modified.
    reserved Boolean
    When true, this field is reserved for system use and cannot be deleted.
    created string
    Timestamp when the field was created.
    deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified string
    Timestamp when the field was last modified.
    reserved boolean
    When true, this field is reserved for system use and cannot be deleted.
    created str
    Timestamp when the field was created.
    deleted str
    Timestamp when the field was soft-deleted, or null if not deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified str
    Timestamp when the field was last modified.
    reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    created String
    Timestamp when the field was created.
    deleted String
    Timestamp when the field was soft-deleted, or null if not deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Property Map
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified String
    Timestamp when the field was last modified.
    reserved Boolean
    When true, this field is reserved for system use and cannot be deleted.

    Look up Existing IncidentUserDefinedField Resource

    Get an existing IncidentUserDefinedField 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?: IncidentUserDefinedFieldState, opts?: CustomResourceOptions): IncidentUserDefinedField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        created: Optional[str] = None,
        default_value: Optional[str] = None,
        deleted: Optional[str] = None,
        display_name: Optional[str] = None,
        incident_type: Optional[str] = None,
        metadata: Optional[IncidentUserDefinedFieldMetadataArgs] = None,
        modified: Optional[str] = None,
        name: Optional[str] = None,
        ordinal: Optional[str] = None,
        required: Optional[bool] = None,
        reserved: Optional[bool] = None,
        tag_key: Optional[str] = None,
        type: Optional[str] = None,
        valid_values: Optional[Sequence[IncidentUserDefinedFieldValidValueArgs]] = None) -> IncidentUserDefinedField
    func GetIncidentUserDefinedField(ctx *Context, name string, id IDInput, state *IncidentUserDefinedFieldState, opts ...ResourceOption) (*IncidentUserDefinedField, error)
    public static IncidentUserDefinedField Get(string name, Input<string> id, IncidentUserDefinedFieldState? state, CustomResourceOptions? opts = null)
    public static IncidentUserDefinedField get(String name, Output<String> id, IncidentUserDefinedFieldState state, CustomResourceOptions options)
    resources:  _:    type: datadog:IncidentUserDefinedField    get:      id: ${id}
    import {
  to = datadog_incident_user_defined_field.example
  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:
    Category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    Created string
    Timestamp when the field was created.
    DefaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    Deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    DisplayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    IncidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    Metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    Modified string
    Timestamp when the field was last modified.
    Name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    Ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    Required bool
    When true, users must fill out this field on incidents. Defaults to false.
    Reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    TagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    Type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    ValidValues List<IncidentUserDefinedFieldValidValue>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    Category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    Created string
    Timestamp when the field was created.
    DefaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    Deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    DisplayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    IncidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    Metadata IncidentUserDefinedFieldMetadataArgs
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    Modified string
    Timestamp when the field was last modified.
    Name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    Ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    Required bool
    When true, users must fill out this field on incidents. Defaults to false.
    Reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    TagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    Type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    ValidValues []IncidentUserDefinedFieldValidValueArgs
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    created string
    Timestamp when the field was created.
    default_value string
    The default value for the field. Must be one of the valid values when validValues is set.
    deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    display_name string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    incident_type string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    metadata object
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified string
    Timestamp when the field was last modified.
    name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required bool
    When true, users must fill out this field on incidents. Defaults to false.
    reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    tag_key string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    valid_values list(object)
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    category String
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    created String
    Timestamp when the field was created.
    defaultValue String
    The default value for the field. Must be one of the valid values when validValues is set.
    deleted String
    Timestamp when the field was soft-deleted, or null if not deleted.
    displayName String
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    incidentType String
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified String
    Timestamp when the field was last modified.
    name String
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    ordinal String
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required Boolean
    When true, users must fill out this field on incidents. Defaults to false.
    reserved Boolean
    When true, this field is reserved for system use and cannot be deleted.
    tagKey String
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    type String
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    validValues List<IncidentUserDefinedFieldValidValue>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    category string
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    created string
    Timestamp when the field was created.
    defaultValue string
    The default value for the field. Must be one of the valid values when validValues is set.
    deleted string
    Timestamp when the field was soft-deleted, or null if not deleted.
    displayName string
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    incidentType string
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    metadata IncidentUserDefinedFieldMetadata
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified string
    Timestamp when the field was last modified.
    name string
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    ordinal string
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required boolean
    When true, users must fill out this field on incidents. Defaults to false.
    reserved boolean
    When true, this field is reserved for system use and cannot be deleted.
    tagKey string
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    type string
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    validValues IncidentUserDefinedFieldValidValue[]
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    category str
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    created str
    Timestamp when the field was created.
    default_value str
    The default value for the field. Must be one of the valid values when validValues is set.
    deleted str
    Timestamp when the field was soft-deleted, or null if not deleted.
    display_name str
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    incident_type str
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    metadata IncidentUserDefinedFieldMetadataArgs
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified str
    Timestamp when the field was last modified.
    name str
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    ordinal str
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required bool
    When true, users must fill out this field on incidents. Defaults to false.
    reserved bool
    When true, this field is reserved for system use and cannot be deleted.
    tag_key str
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    type str
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    valid_values Sequence[IncidentUserDefinedFieldValidValueArgs]
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.
    category String
    The section in which the field appears: whatHappened or whyItHappened. When unset, the field appears in the Attributes section.
    created String
    Timestamp when the field was created.
    defaultValue String
    The default value for the field. Must be one of the valid values when validValues is set.
    deleted String
    Timestamp when the field was soft-deleted, or null if not deleted.
    displayName String
    The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
    incidentType String
    The ID of the incident type this field is associated with. Changing the incident type forces a new resource.
    metadata Property Map
    Metadata for autocomplete-type fields, describing how to populate autocomplete options. Populated by the server for supported fields.
    modified String
    Timestamp when the field was last modified.
    name String
    The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods. Changing the name forces a new resource.
    ordinal String
    A decimal string representing the field's display order in the UI. Assigned by the server when not provided.
    required Boolean
    When true, users must fill out this field on incidents. Defaults to false.
    reserved Boolean
    When true, this field is reserved for system use and cannot be deleted.
    tagKey String
    For metric tag-type fields only, the metric tag key that powers the autocomplete options. Changing the tag key forces a new resource.
    type String
    The data type of the field. Changing the type forces a new resource. Valid values are dropdown, multiselect, textbox, textarray, metrictag, autocomplete, number, datetime.
    validValues List<Property Map>
    A set of allowed values for dropdown, multiselect, and autocomplete fields; specify one block per value. Limited to 1000 values. The API does not preserve ordering, so this is modeled as an unordered set.

    Supporting Types

    IncidentUserDefinedFieldMetadata, IncidentUserDefinedFieldMetadataArgs

    Category string
    The category of the autocomplete source.
    SearchLimitParam string
    The query parameter used to limit the number of autocomplete results.
    SearchParams Dictionary<string, string>
    Additional query parameters to include in the search URL.
    SearchQueryParam string
    The query parameter used to pass typed input to the search URL.
    SearchResultPath string
    The JSON path to the results in the response body.
    SearchUrl string
    The URL used to populate autocomplete options.
    Category string
    The category of the autocomplete source.
    SearchLimitParam string
    The query parameter used to limit the number of autocomplete results.
    SearchParams map[string]string
    Additional query parameters to include in the search URL.
    SearchQueryParam string
    The query parameter used to pass typed input to the search URL.
    SearchResultPath string
    The JSON path to the results in the response body.
    SearchUrl string
    The URL used to populate autocomplete options.
    category string
    The category of the autocomplete source.
    search_limit_param string
    The query parameter used to limit the number of autocomplete results.
    search_params map(string)
    Additional query parameters to include in the search URL.
    search_query_param string
    The query parameter used to pass typed input to the search URL.
    search_result_path string
    The JSON path to the results in the response body.
    search_url string
    The URL used to populate autocomplete options.
    category String
    The category of the autocomplete source.
    searchLimitParam String
    The query parameter used to limit the number of autocomplete results.
    searchParams Map<String,String>
    Additional query parameters to include in the search URL.
    searchQueryParam String
    The query parameter used to pass typed input to the search URL.
    searchResultPath String
    The JSON path to the results in the response body.
    searchUrl String
    The URL used to populate autocomplete options.
    category string
    The category of the autocomplete source.
    searchLimitParam string
    The query parameter used to limit the number of autocomplete results.
    searchParams {[key: string]: string}
    Additional query parameters to include in the search URL.
    searchQueryParam string
    The query parameter used to pass typed input to the search URL.
    searchResultPath string
    The JSON path to the results in the response body.
    searchUrl string
    The URL used to populate autocomplete options.
    category str
    The category of the autocomplete source.
    search_limit_param str
    The query parameter used to limit the number of autocomplete results.
    search_params Mapping[str, str]
    Additional query parameters to include in the search URL.
    search_query_param str
    The query parameter used to pass typed input to the search URL.
    search_result_path str
    The JSON path to the results in the response body.
    search_url str
    The URL used to populate autocomplete options.
    category String
    The category of the autocomplete source.
    searchLimitParam String
    The query parameter used to limit the number of autocomplete results.
    searchParams Map<String>
    Additional query parameters to include in the search URL.
    searchQueryParam String
    The query parameter used to pass typed input to the search URL.
    searchResultPath String
    The JSON path to the results in the response body.
    searchUrl String
    The URL used to populate autocomplete options.

    IncidentUserDefinedFieldValidValue, IncidentUserDefinedFieldValidValueArgs

    DisplayName string
    The human-readable display name for this value.
    Value string
    The identifier that is stored when this option is selected.
    Description string
    A detailed description of the valid value.
    ShortDescription string
    A short description of the valid value.
    DisplayName string
    The human-readable display name for this value.
    Value string
    The identifier that is stored when this option is selected.
    Description string
    A detailed description of the valid value.
    ShortDescription string
    A short description of the valid value.
    display_name string
    The human-readable display name for this value.
    value string
    The identifier that is stored when this option is selected.
    description string
    A detailed description of the valid value.
    short_description string
    A short description of the valid value.
    displayName String
    The human-readable display name for this value.
    value String
    The identifier that is stored when this option is selected.
    description String
    A detailed description of the valid value.
    shortDescription String
    A short description of the valid value.
    displayName string
    The human-readable display name for this value.
    value string
    The identifier that is stored when this option is selected.
    description string
    A detailed description of the valid value.
    shortDescription string
    A short description of the valid value.
    display_name str
    The human-readable display name for this value.
    value str
    The identifier that is stored when this option is selected.
    description str
    A detailed description of the valid value.
    short_description str
    A short description of the valid value.
    displayName String
    The human-readable display name for this value.
    value String
    The identifier that is stored when this option is selected.
    description String
    A detailed description of the valid value.
    shortDescription String
    A short description of the valid value.

    Import

    The pulumi import command can be used, for example:

    $ pulumi import datadog:index/incidentUserDefinedField:IncidentUserDefinedField example "12345678-1234-1234-1234-1234567890ab"

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

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Viewing docs for Datadog v5.9.0
    published on Saturday, Jul 25, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial