Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Incident Provider
  3. API Docs
  4. Status
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
incident-io/terraform-provider-incident

incident.Status

Explore with Pulumi AI

incident logo
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
incident-io/terraform-provider-incident

    Manage incident statuses.

    Each incident has a status, picked from one of the statuses configured in your organisations settings.

    Statuses help communicate where an incident is in its lifecycle. You can use statuses when filtering incidents in the dashboard, and in workflows and announcement rules.

    Example Usage

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

// Create an additional closed status called "Clean-up".
const cleanUp = new incident.Status("cleanUp", {
    category: "closed",
    description: "Not yet fully finished, but isn't a live incident anymore.",
});

    import pulumi
import pulumi_incident as incident

# Create an additional closed status called "Clean-up".
clean_up = incident.Status("cleanUp",
    category="closed",
    description="Not yet fully finished, but isn't a live incident anymore.")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/incident/v5/incident"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create an additional closed status called "Clean-up".
		_, err := incident.NewStatus(ctx, "cleanUp", &incident.StatusArgs{
			Category:    pulumi.String("closed"),
			Description: pulumi.String("Not yet fully finished, but isn't a live incident anymore."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create an additional closed status called "Clean-up".
    var cleanUp = new Incident.Status("cleanUp", new()
    {
        Category = "closed",
        Description = "Not yet fully finished, but isn't a live incident anymore.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.incident.Status;
import com.pulumi.incident.StatusArgs;
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) {
        // Create an additional closed status called "Clean-up".
        var cleanUp = new Status("cleanUp", StatusArgs.builder()
            .category("closed")
            .description("Not yet fully finished, but isn't a live incident anymore.")
            .build());

    }
}

    resources:
  # Create an additional closed status called "Clean-up".
  cleanUp:
    type: incident:Status
    properties:
      category: closed
      description: Not yet fully finished, but isn't a live incident anymore.

    Create Status Resource

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

    Constructor syntax

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

@overload
def Status(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           category: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None)
    func NewStatus(ctx *Context, name string, args StatusArgs, opts ...ResourceOption) (*Status, error)
    public Status(string name, StatusArgs args, CustomResourceOptions? opts = null)
    public Status(String name, StatusArgs args)
public Status(String name, StatusArgs args, CustomResourceOptions options)

    type: incident:Status
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 StatusArgs
    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 StatusArgs
    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 StatusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusArgs
    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 statusResource = new Incident.Status("statusResource", new()
{
    Category = "string",
    Description = "string",
    Name = "string",
});

    example, err := incident.NewStatus(ctx, "statusResource", &incident.StatusArgs{
	Category:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var statusResource = new Status("statusResource", StatusArgs.builder()
    .category("string")
    .description("string")
    .name("string")
    .build());

    status_resource = incident.Status("statusResource",
    category="string",
    description="string",
    name="string")

    const statusResource = new incident.Status("statusResource", {
    category: "string",
    description: "string",
    name: "string",
});

    type: incident:Status
properties:
    category: string
    description: string
    name: string

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

    Category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    Description string
    Rich text description of the incident status
    Name string
    Unique name of this status
    Category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    Description string
    Rich text description of the incident status
    Name string
    Unique name of this status
    category String
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description String
    Rich text description of the incident status
    name String
    Unique name of this status
    category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description string
    Rich text description of the incident status
    name string
    Unique name of this status
    category str
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description str
    Rich text description of the incident status
    name str
    Unique name of this status
    category String
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description String
    Rich text description of the incident status
    name String
    Unique name of this status

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Status 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 Status Resource

    Get an existing Status 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?: StatusState, opts?: CustomResourceOptions): Status
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> Status
    func GetStatus(ctx *Context, name string, id IDInput, state *StatusState, opts ...ResourceOption) (*Status, error)
    public static Status Get(string name, Input<string> id, StatusState? state, CustomResourceOptions? opts = null)
    public static Status get(String name, Output<String> id, StatusState state, CustomResourceOptions options)
    resources:  _:    type: incident:Status    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:
    Category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    Description string
    Rich text description of the incident status
    Name string
    Unique name of this status
    Category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    Description string
    Rich text description of the incident status
    Name string
    Unique name of this status
    category String
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description String
    Rich text description of the incident status
    name String
    Unique name of this status
    category string
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description string
    Rich text description of the incident status
    name string
    Unique name of this status
    category str
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description str
    Rich text description of the incident status
    name str
    Unique name of this status
    category String
    What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured
    description String
    Rich text description of the incident status
    name String
    Unique name of this status

    Import

    #!/bin/bash

    Import a status using its ID

    Replace the ID with a real ID from your incident.io organization

    $ pulumi import incident:index/status:Status example 01ABC123DEF456GHI789JKL

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

    Package Details

    Repository
    incident incident-io/terraform-provider-incident
    License
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    incident logo
    incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io
    incident-io/terraform-provider-incident