CatalogProperty

Rootly v3.3.0, May 7 26

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Example Usage

resource "rootly_catalog_property" "support_level" {
  catalog_id = rootly_catalog.customer_tier.id
  name       = "Support Level"
  kind       = "select"
}

Create CatalogProperty Resource

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

Constructor syntax

new CatalogProperty(name: string, args?: CatalogPropertyArgs, opts?: CustomResourceOptions);

@overload
def CatalogProperty(resource_name: str,
                    args: Optional[CatalogPropertyArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def CatalogProperty(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    catalog_id: Optional[str] = None,
                    catalog_type: Optional[str] = None,
                    kind: Optional[str] = None,
                    kind_catalog_id: Optional[str] = None,
                    multiple: Optional[bool] = None,
                    name: Optional[str] = None,
                    required: Optional[bool] = None,
                    slug: Optional[str] = None)

func NewCatalogProperty(ctx *Context, name string, args *CatalogPropertyArgs, opts ...ResourceOption) (*CatalogProperty, error)

public CatalogProperty(string name, CatalogPropertyArgs? args = null, CustomResourceOptions? opts = null)

public CatalogProperty(String name, CatalogPropertyArgs args)
public CatalogProperty(String name, CatalogPropertyArgs args, CustomResourceOptions options)

type: rootly:CatalogProperty
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 CatalogPropertyArgs: 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 CatalogPropertyArgs: 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 CatalogPropertyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CatalogPropertyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CatalogPropertyArgs: 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 catalogPropertyResource = new Rootly.CatalogProperty("catalogPropertyResource", new()
{
    CatalogId = "string",
    CatalogType = "string",
    Kind = "string",
    KindCatalogId = "string",
    Multiple = false,
    Name = "string",
    Required = false,
    Slug = "string",
});

example, err := rootly.NewCatalogProperty(ctx, "catalogPropertyResource", &rootly.CatalogPropertyArgs{
	CatalogId:     pulumi.String("string"),
	CatalogType:   pulumi.String("string"),
	Kind:          pulumi.String("string"),
	KindCatalogId: pulumi.String("string"),
	Multiple:      pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Required:      pulumi.Bool(false),
	Slug:          pulumi.String("string"),
})

var catalogPropertyResource = new CatalogProperty("catalogPropertyResource", CatalogPropertyArgs.builder()
    .catalogId("string")
    .catalogType("string")
    .kind("string")
    .kindCatalogId("string")
    .multiple(false)
    .name("string")
    .required(false)
    .slug("string")
    .build());

catalog_property_resource = rootly.CatalogProperty("catalogPropertyResource",
    catalog_id="string",
    catalog_type="string",
    kind="string",
    kind_catalog_id="string",
    multiple=False,
    name="string",
    required=False,
    slug="string")

const catalogPropertyResource = new rootly.CatalogProperty("catalogPropertyResource", {
    catalogId: "string",
    catalogType: "string",
    kind: "string",
    kindCatalogId: "string",
    multiple: false,
    name: "string",
    required: false,
    slug: "string",
});

type: rootly:CatalogProperty
properties:
    catalogId: string
    catalogType: string
    kind: string
    kindCatalogId: string
    multiple: false
    name: string
    required: false
    slug: string

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

CatalogId string
CatalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
Kind string: Value must be one of text, reference.
KindCatalogId string: Restricts values to items of specified catalog.
Multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
Name string
Required bool: Whether the property is required.. Value must be one of true or false
Slug string

CatalogId string
CatalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
Kind string: Value must be one of text, reference.
KindCatalogId string: Restricts values to items of specified catalog.
Multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
Name string
Required bool: Whether the property is required.. Value must be one of true or false
Slug string

catalogId String
catalogType String: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind String: Value must be one of text, reference.
kindCatalogId String: Restricts values to items of specified catalog.
multiple Boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name String
required Boolean: Whether the property is required.. Value must be one of true or false
slug String

catalogId string
catalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind string: Value must be one of text, reference.
kindCatalogId string: Restricts values to items of specified catalog.
multiple boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name string
required boolean: Whether the property is required.. Value must be one of true or false
slug string

catalog_id str
catalog_type str: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind str: Value must be one of text, reference.
kind_catalog_id str: Restricts values to items of specified catalog.
multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
name str
required bool: Whether the property is required.. Value must be one of true or false
slug str

catalogId String
catalogType String: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind String: Value must be one of text, reference.
kindCatalogId String: Restricts values to items of specified catalog.
multiple Boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name String
required Boolean: Whether the property is required.. Value must be one of true or false
slug String

Outputs

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

Get an existing CatalogProperty 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?: CatalogPropertyState, opts?: CustomResourceOptions): CatalogProperty

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        catalog_type: Optional[str] = None,
        kind: Optional[str] = None,
        kind_catalog_id: Optional[str] = None,
        multiple: Optional[bool] = None,
        name: Optional[str] = None,
        required: Optional[bool] = None,
        slug: Optional[str] = None) -> CatalogProperty

func GetCatalogProperty(ctx *Context, name string, id IDInput, state *CatalogPropertyState, opts ...ResourceOption) (*CatalogProperty, error)

public static CatalogProperty Get(string name, Input<string> id, CatalogPropertyState? state, CustomResourceOptions? opts = null)

public static CatalogProperty get(String name, Output<String> id, CatalogPropertyState state, CustomResourceOptions options)

resources:  _:    type: rootly:CatalogProperty    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:

CatalogId string
CatalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
Kind string: Value must be one of text, reference.
KindCatalogId string: Restricts values to items of specified catalog.
Multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
Name string
Required bool: Whether the property is required.. Value must be one of true or false
Slug string

CatalogId string
CatalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
Kind string: Value must be one of text, reference.
KindCatalogId string: Restricts values to items of specified catalog.
Multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
Name string
Required bool: Whether the property is required.. Value must be one of true or false
Slug string

catalogId String
catalogType String: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind String: Value must be one of text, reference.
kindCatalogId String: Restricts values to items of specified catalog.
multiple Boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name String
required Boolean: Whether the property is required.. Value must be one of true or false
slug String

catalogId string
catalogType string: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind string: Value must be one of text, reference.
kindCatalogId string: Restricts values to items of specified catalog.
multiple boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name string
required boolean: Whether the property is required.. Value must be one of true or false
slug string

catalog_id str
catalog_type str: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind str: Value must be one of text, reference.
kind_catalog_id str: Restricts values to items of specified catalog.
multiple bool: Whether the attribute accepts multiple values.. Value must be one of true or false
name str
required bool: Whether the property is required.. Value must be one of true or false
slug str

catalogId String
catalogType String: The type of catalog the property belongs to.. Value must be one of catalog, cause, environment, functionality, incidentType, service, team.
kind String: Value must be one of text, reference.
kindCatalogId String: Restricts values to items of specified catalog.
multiple Boolean: Whether the attribute accepts multiple values.. Value must be one of true or false
name String
required Boolean: Whether the property is required.. Value must be one of true or false
slug String

Import

rootly.CatalogProperty can be imported using the import command.

$ pulumi import rootly:index/catalogProperty:CatalogProperty 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.

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

rootly.CatalogProperty

On this page

On this page

Example Usage

Create CatalogProperty Resource

Constructor syntax

Parameters

Constructor example

CatalogProperty Resource Properties

Inputs

Outputs

Look up Existing CatalogProperty Resource

Import

Package Details

On this page

On this page