1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. IncidentType
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

    Example Usage

    resource "rootly_incident_type" "security_breach" {
      name        = "Security Breach"
      description = "Unauthorized access or data exposure incidents"
      color       = "#FF0000"
    }
    
    resource "rootly_incident_type" "service_degradation" {
      name        = "Service Degradation"
      description = "Partial or full service outage affecting customers"
      color       = "#FFA500"
    }
    

    Create IncidentType Resource

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

    Constructor syntax

    new IncidentType(name: string, args?: IncidentTypeArgs, opts?: CustomResourceOptions);
    @overload
    def IncidentType(resource_name: str,
                     args: Optional[IncidentTypeArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def IncidentType(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     color: Optional[str] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     notify_emails: Optional[Sequence[str]] = None,
                     position: Optional[int] = None,
                     properties: Optional[Sequence[IncidentTypePropertyArgs]] = None,
                     slack_aliases: Optional[Sequence[IncidentTypeSlackAliasArgs]] = None,
                     slack_channels: Optional[Sequence[IncidentTypeSlackChannelArgs]] = None,
                     slug: Optional[str] = None)
    func NewIncidentType(ctx *Context, name string, args *IncidentTypeArgs, opts ...ResourceOption) (*IncidentType, error)
    public IncidentType(string name, IncidentTypeArgs? args = null, CustomResourceOptions? opts = null)
    public IncidentType(String name, IncidentTypeArgs args)
    public IncidentType(String name, IncidentTypeArgs args, CustomResourceOptions options)
    
    type: rootly:IncidentType
    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 IncidentTypeArgs
    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 IncidentTypeArgs
    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 IncidentTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IncidentTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IncidentTypeArgs
    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 incidentTypeResource = new Rootly.IncidentType("incidentTypeResource", new()
    {
        Color = "string",
        Description = "string",
        Name = "string",
        NotifyEmails = new[]
        {
            "string",
        },
        Position = 0,
        Properties = new[]
        {
            new Rootly.Inputs.IncidentTypePropertyArgs
            {
                CatalogPropertyId = "string",
                Value = "string",
            },
        },
        SlackAliases = new[]
        {
            new Rootly.Inputs.IncidentTypeSlackAliasArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        SlackChannels = new[]
        {
            new Rootly.Inputs.IncidentTypeSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        Slug = "string",
    });
    
    example, err := rootly.NewIncidentType(ctx, "incidentTypeResource", &rootly.IncidentTypeArgs{
    	Color:       pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	NotifyEmails: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Position: pulumi.Int(0),
    	Properties: rootly.IncidentTypePropertyArray{
    		&rootly.IncidentTypePropertyArgs{
    			CatalogPropertyId: pulumi.String("string"),
    			Value:             pulumi.String("string"),
    		},
    	},
    	SlackAliases: rootly.IncidentTypeSlackAliasArray{
    		&rootly.IncidentTypeSlackAliasArgs{
    			Id:   pulumi.String("string"),
    			Name: pulumi.String("string"),
    		},
    	},
    	SlackChannels: rootly.IncidentTypeSlackChannelArray{
    		&rootly.IncidentTypeSlackChannelArgs{
    			Id:   pulumi.String("string"),
    			Name: pulumi.String("string"),
    		},
    	},
    	Slug: pulumi.String("string"),
    })
    
    var incidentTypeResource = new IncidentType("incidentTypeResource", IncidentTypeArgs.builder()
        .color("string")
        .description("string")
        .name("string")
        .notifyEmails("string")
        .position(0)
        .properties(IncidentTypePropertyArgs.builder()
            .catalogPropertyId("string")
            .value("string")
            .build())
        .slackAliases(IncidentTypeSlackAliasArgs.builder()
            .id("string")
            .name("string")
            .build())
        .slackChannels(IncidentTypeSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .slug("string")
        .build());
    
    incident_type_resource = rootly.IncidentType("incidentTypeResource",
        color="string",
        description="string",
        name="string",
        notify_emails=["string"],
        position=0,
        properties=[{
            "catalog_property_id": "string",
            "value": "string",
        }],
        slack_aliases=[{
            "id": "string",
            "name": "string",
        }],
        slack_channels=[{
            "id": "string",
            "name": "string",
        }],
        slug="string")
    
    const incidentTypeResource = new rootly.IncidentType("incidentTypeResource", {
        color: "string",
        description: "string",
        name: "string",
        notifyEmails: ["string"],
        position: 0,
        properties: [{
            catalogPropertyId: "string",
            value: "string",
        }],
        slackAliases: [{
            id: "string",
            name: "string",
        }],
        slackChannels: [{
            id: "string",
            name: "string",
        }],
        slug: "string",
    });
    
    type: rootly:IncidentType
    properties:
        color: string
        description: string
        name: string
        notifyEmails:
            - string
        position: 0
        properties:
            - catalogPropertyId: string
              value: string
        slackAliases:
            - id: string
              name: string
        slackChannels:
            - id: string
              name: string
        slug: string
    

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

    Color string
    The hex color of the incident type
    Description string
    The description of the incident type
    Name string
    The name of the incident type
    NotifyEmails List<string>
    Emails to attach to the incident type
    Position int
    Position of the incident type
    Properties List<IncidentTypeProperty>
    Array of property values for this incident type.
    SlackAliases List<IncidentTypeSlackAlias>
    Slack Aliases associated with this incident type
    SlackChannels List<IncidentTypeSlackChannel>
    Slack Channels associated with this incident type
    Slug string
    The slug of the incident type
    Color string
    The hex color of the incident type
    Description string
    The description of the incident type
    Name string
    The name of the incident type
    NotifyEmails []string
    Emails to attach to the incident type
    Position int
    Position of the incident type
    Properties []IncidentTypePropertyArgs
    Array of property values for this incident type.
    SlackAliases []IncidentTypeSlackAliasArgs
    Slack Aliases associated with this incident type
    SlackChannels []IncidentTypeSlackChannelArgs
    Slack Channels associated with this incident type
    Slug string
    The slug of the incident type
    color String
    The hex color of the incident type
    description String
    The description of the incident type
    name String
    The name of the incident type
    notifyEmails List<String>
    Emails to attach to the incident type
    position Integer
    Position of the incident type
    properties List<IncidentTypeProperty>
    Array of property values for this incident type.
    slackAliases List<IncidentTypeSlackAlias>
    Slack Aliases associated with this incident type
    slackChannels List<IncidentTypeSlackChannel>
    Slack Channels associated with this incident type
    slug String
    The slug of the incident type
    color string
    The hex color of the incident type
    description string
    The description of the incident type
    name string
    The name of the incident type
    notifyEmails string[]
    Emails to attach to the incident type
    position number
    Position of the incident type
    properties IncidentTypeProperty[]
    Array of property values for this incident type.
    slackAliases IncidentTypeSlackAlias[]
    Slack Aliases associated with this incident type
    slackChannels IncidentTypeSlackChannel[]
    Slack Channels associated with this incident type
    slug string
    The slug of the incident type
    color str
    The hex color of the incident type
    description str
    The description of the incident type
    name str
    The name of the incident type
    notify_emails Sequence[str]
    Emails to attach to the incident type
    position int
    Position of the incident type
    properties Sequence[IncidentTypePropertyArgs]
    Array of property values for this incident type.
    slack_aliases Sequence[IncidentTypeSlackAliasArgs]
    Slack Aliases associated with this incident type
    slack_channels Sequence[IncidentTypeSlackChannelArgs]
    Slack Channels associated with this incident type
    slug str
    The slug of the incident type
    color String
    The hex color of the incident type
    description String
    The description of the incident type
    name String
    The name of the incident type
    notifyEmails List<String>
    Emails to attach to the incident type
    position Number
    Position of the incident type
    properties List<Property Map>
    Array of property values for this incident type.
    slackAliases List<Property Map>
    Slack Aliases associated with this incident type
    slackChannels List<Property Map>
    Slack Channels associated with this incident type
    slug String
    The slug of the incident type

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IncidentType Resource

    Get an existing IncidentType 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?: IncidentTypeState, opts?: CustomResourceOptions): IncidentType
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            color: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            notify_emails: Optional[Sequence[str]] = None,
            position: Optional[int] = None,
            properties: Optional[Sequence[IncidentTypePropertyArgs]] = None,
            slack_aliases: Optional[Sequence[IncidentTypeSlackAliasArgs]] = None,
            slack_channels: Optional[Sequence[IncidentTypeSlackChannelArgs]] = None,
            slug: Optional[str] = None) -> IncidentType
    func GetIncidentType(ctx *Context, name string, id IDInput, state *IncidentTypeState, opts ...ResourceOption) (*IncidentType, error)
    public static IncidentType Get(string name, Input<string> id, IncidentTypeState? state, CustomResourceOptions? opts = null)
    public static IncidentType get(String name, Output<String> id, IncidentTypeState state, CustomResourceOptions options)
    resources:  _:    type: rootly:IncidentType    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:
    Color string
    The hex color of the incident type
    Description string
    The description of the incident type
    Name string
    The name of the incident type
    NotifyEmails List<string>
    Emails to attach to the incident type
    Position int
    Position of the incident type
    Properties List<IncidentTypeProperty>
    Array of property values for this incident type.
    SlackAliases List<IncidentTypeSlackAlias>
    Slack Aliases associated with this incident type
    SlackChannels List<IncidentTypeSlackChannel>
    Slack Channels associated with this incident type
    Slug string
    The slug of the incident type
    Color string
    The hex color of the incident type
    Description string
    The description of the incident type
    Name string
    The name of the incident type
    NotifyEmails []string
    Emails to attach to the incident type
    Position int
    Position of the incident type
    Properties []IncidentTypePropertyArgs
    Array of property values for this incident type.
    SlackAliases []IncidentTypeSlackAliasArgs
    Slack Aliases associated with this incident type
    SlackChannels []IncidentTypeSlackChannelArgs
    Slack Channels associated with this incident type
    Slug string
    The slug of the incident type
    color String
    The hex color of the incident type
    description String
    The description of the incident type
    name String
    The name of the incident type
    notifyEmails List<String>
    Emails to attach to the incident type
    position Integer
    Position of the incident type
    properties List<IncidentTypeProperty>
    Array of property values for this incident type.
    slackAliases List<IncidentTypeSlackAlias>
    Slack Aliases associated with this incident type
    slackChannels List<IncidentTypeSlackChannel>
    Slack Channels associated with this incident type
    slug String
    The slug of the incident type
    color string
    The hex color of the incident type
    description string
    The description of the incident type
    name string
    The name of the incident type
    notifyEmails string[]
    Emails to attach to the incident type
    position number
    Position of the incident type
    properties IncidentTypeProperty[]
    Array of property values for this incident type.
    slackAliases IncidentTypeSlackAlias[]
    Slack Aliases associated with this incident type
    slackChannels IncidentTypeSlackChannel[]
    Slack Channels associated with this incident type
    slug string
    The slug of the incident type
    color str
    The hex color of the incident type
    description str
    The description of the incident type
    name str
    The name of the incident type
    notify_emails Sequence[str]
    Emails to attach to the incident type
    position int
    Position of the incident type
    properties Sequence[IncidentTypePropertyArgs]
    Array of property values for this incident type.
    slack_aliases Sequence[IncidentTypeSlackAliasArgs]
    Slack Aliases associated with this incident type
    slack_channels Sequence[IncidentTypeSlackChannelArgs]
    Slack Channels associated with this incident type
    slug str
    The slug of the incident type
    color String
    The hex color of the incident type
    description String
    The description of the incident type
    name String
    The name of the incident type
    notifyEmails List<String>
    Emails to attach to the incident type
    position Number
    Position of the incident type
    properties List<Property Map>
    Array of property values for this incident type.
    slackAliases List<Property Map>
    Slack Aliases associated with this incident type
    slackChannels List<Property Map>
    Slack Channels associated with this incident type
    slug String
    The slug of the incident type

    Supporting Types

    IncidentTypeProperty, IncidentTypePropertyArgs

    CatalogPropertyId string
    Catalog property ID
    Value string
    The property value
    CatalogPropertyId string
    Catalog property ID
    Value string
    The property value
    catalogPropertyId String
    Catalog property ID
    value String
    The property value
    catalogPropertyId string
    Catalog property ID
    value string
    The property value
    catalog_property_id str
    Catalog property ID
    value str
    The property value
    catalogPropertyId String
    Catalog property ID
    value String
    The property value

    IncidentTypeSlackAlias, IncidentTypeSlackAliasArgs

    Id string
    Slack alias ID
    Name string
    Slack alias name
    Id string
    Slack alias ID
    Name string
    Slack alias name
    id String
    Slack alias ID
    name String
    Slack alias name
    id string
    Slack alias ID
    name string
    Slack alias name
    id str
    Slack alias ID
    name str
    Slack alias name
    id String
    Slack alias ID
    name String
    Slack alias name

    IncidentTypeSlackChannel, IncidentTypeSlackChannelArgs

    Id string
    Slack channel ID
    Name string
    Slack channel name
    Id string
    Slack channel ID
    Name string
    Slack channel name
    id String
    Slack channel ID
    name String
    Slack channel name
    id string
    Slack channel ID
    name string
    Slack channel name
    id str
    Slack channel ID
    name str
    Slack channel name
    id String
    Slack channel ID
    name String
    Slack channel name

    Import

    rootly.IncidentType can be imported using the import command.

    $ pulumi import rootly:index/incidentType:IncidentType primary a816421c-6ceb-481a-87c4-585e47451f24
    

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf
    

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

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
      Try Pulumi Cloud free. Your team will thank you.