1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. Cause
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.Cause

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_cause" "bad_deploy" {
  name        = "Bad Deploy"
  description = "Incident caused by a faulty deployment"
}

resource "rootly_cause" "infrastructure_failure" {
  name        = "Infrastructure Failure"
  description = "Hardware or cloud provider issue"
}

    Create Cause Resource

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

    Constructor syntax

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

@overload
def Cause(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          position: Optional[int] = None,
          properties: Optional[Sequence[CausePropertyArgs]] = None,
          slug: Optional[str] = None)
    func NewCause(ctx *Context, name string, args *CauseArgs, opts ...ResourceOption) (*Cause, error)
    public Cause(string name, CauseArgs? args = null, CustomResourceOptions? opts = null)
    public Cause(String name, CauseArgs args)
public Cause(String name, CauseArgs args, CustomResourceOptions options)

    type: rootly:Cause
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 CauseArgs
    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 CauseArgs
    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 CauseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CauseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CauseArgs
    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 causeResource = new Rootly.Cause("causeResource", new()
{
    Description = "string",
    Name = "string",
    Position = 0,
    Properties = new[]
    {
        new Rootly.Inputs.CausePropertyArgs
        {
            CatalogPropertyId = "string",
            Value = "string",
        },
    },
    Slug = "string",
});

    example, err := rootly.NewCause(ctx, "causeResource", &rootly.CauseArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Position:    pulumi.Int(0),
	Properties: rootly.CausePropertyArray{
		&rootly.CausePropertyArgs{
			CatalogPropertyId: pulumi.String("string"),
			Value:             pulumi.String("string"),
		},
	},
	Slug: pulumi.String("string"),
})

    var causeResource = new Cause("causeResource", CauseArgs.builder()
    .description("string")
    .name("string")
    .position(0)
    .properties(CausePropertyArgs.builder()
        .catalogPropertyId("string")
        .value("string")
        .build())
    .slug("string")
    .build());

    cause_resource = rootly.Cause("causeResource",
    description="string",
    name="string",
    position=0,
    properties=[{
        "catalog_property_id": "string",
        "value": "string",
    }],
    slug="string")

    const causeResource = new rootly.Cause("causeResource", {
    description: "string",
    name: "string",
    position: 0,
    properties: [{
        catalogPropertyId: "string",
        value: "string",
    }],
    slug: "string",
});

    type: rootly:Cause
properties:
    description: string
    name: string
    position: 0
    properties:
        - catalogPropertyId: string
          value: string
    slug: string

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

    Description string
    The description of the cause
    Name string
    The name of the cause
    Position int
    Position of the cause
    Properties List<CauseProperty>
    Array of property values for this cause.
    Slug string
    The slug of the cause
    Description string
    The description of the cause
    Name string
    The name of the cause
    Position int
    Position of the cause
    Properties []CausePropertyArgs
    Array of property values for this cause.
    Slug string
    The slug of the cause
    description String
    The description of the cause
    name String
    The name of the cause
    position Integer
    Position of the cause
    properties List<CauseProperty>
    Array of property values for this cause.
    slug String
    The slug of the cause
    description string
    The description of the cause
    name string
    The name of the cause
    position number
    Position of the cause
    properties CauseProperty[]
    Array of property values for this cause.
    slug string
    The slug of the cause
    description str
    The description of the cause
    name str
    The name of the cause
    position int
    Position of the cause
    properties Sequence[CausePropertyArgs]
    Array of property values for this cause.
    slug str
    The slug of the cause
    description String
    The description of the cause
    name String
    The name of the cause
    position Number
    Position of the cause
    properties List<Property Map>
    Array of property values for this cause.
    slug String
    The slug of the cause

    Outputs

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

    Get an existing Cause 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?: CauseState, opts?: CustomResourceOptions): Cause
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        properties: Optional[Sequence[CausePropertyArgs]] = None,
        slug: Optional[str] = None) -> Cause
    func GetCause(ctx *Context, name string, id IDInput, state *CauseState, opts ...ResourceOption) (*Cause, error)
    public static Cause Get(string name, Input<string> id, CauseState? state, CustomResourceOptions? opts = null)
    public static Cause get(String name, Output<String> id, CauseState state, CustomResourceOptions options)
    resources:  _:    type: rootly:Cause    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:
    Description string
    The description of the cause
    Name string
    The name of the cause
    Position int
    Position of the cause
    Properties List<CauseProperty>
    Array of property values for this cause.
    Slug string
    The slug of the cause
    Description string
    The description of the cause
    Name string
    The name of the cause
    Position int
    Position of the cause
    Properties []CausePropertyArgs
    Array of property values for this cause.
    Slug string
    The slug of the cause
    description String
    The description of the cause
    name String
    The name of the cause
    position Integer
    Position of the cause
    properties List<CauseProperty>
    Array of property values for this cause.
    slug String
    The slug of the cause
    description string
    The description of the cause
    name string
    The name of the cause
    position number
    Position of the cause
    properties CauseProperty[]
    Array of property values for this cause.
    slug string
    The slug of the cause
    description str
    The description of the cause
    name str
    The name of the cause
    position int
    Position of the cause
    properties Sequence[CausePropertyArgs]
    Array of property values for this cause.
    slug str
    The slug of the cause
    description String
    The description of the cause
    name String
    The name of the cause
    position Number
    Position of the cause
    properties List<Property Map>
    Array of property values for this cause.
    slug String
    The slug of the cause

    Supporting Types

    CauseProperty, CausePropertyArgs

    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

    Import

    rootly.Cause can be imported using the import command.

    $ pulumi import rootly:index/cause:Cause 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
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.