Viewing docs for Rootly v3.8.0
published on Thursday, Jul 30, 2026 by rootlyhq
published on Thursday, Jul 30, 2026 by rootlyhq
Viewing docs for Rootly v3.8.0
published on Thursday, Jul 30, 2026 by rootlyhq
published on Thursday, Jul 30, 2026 by rootlyhq
Example Usage
resource "rootly_catalog" "customer_tier" {
name = "Customer Tier"
description = "Customer pricing tiers"
kind = "service"
}
Create Catalog Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Catalog(name: string, args?: CatalogArgs, opts?: CustomResourceOptions);@overload
def Catalog(resource_name: str,
args: Optional[CatalogArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Catalog(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
external_id: Optional[str] = None,
icon: Optional[str] = None,
name: Optional[str] = None,
position: Optional[int] = None)func NewCatalog(ctx *Context, name string, args *CatalogArgs, opts ...ResourceOption) (*Catalog, error)public Catalog(string name, CatalogArgs? args = null, CustomResourceOptions? opts = null)
public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)
type: rootly:Catalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "rootly_catalog" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CatalogArgs
- 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 CatalogArgs
- 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 CatalogArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CatalogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CatalogArgs
- 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 catalogResource = new Rootly.Catalog("catalogResource", new()
{
Description = "string",
ExternalId = "string",
Icon = "string",
Name = "string",
Position = 0,
});
example, err := rootly.NewCatalog(ctx, "catalogResource", &rootly.CatalogArgs{
Description: pulumi.String("string"),
ExternalId: pulumi.String("string"),
Icon: pulumi.String("string"),
Name: pulumi.String("string"),
Position: pulumi.Int(0),
})
resource "rootly_catalog" "catalogResource" {
lifecycle {
create_before_destroy = true
}
description = "string"
external_id = "string"
icon = "string"
name = "string"
position = 0
}
var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
.description("string")
.externalId("string")
.icon("string")
.name("string")
.position(0)
.build());
catalog_resource = rootly.Catalog("catalogResource",
description="string",
external_id="string",
icon="string",
name="string",
position=0)
const catalogResource = new rootly.Catalog("catalogResource", {
description: "string",
externalId: "string",
icon: "string",
name: "string",
position: 0,
});
type: rootly:Catalog
properties:
description: string
externalId: string
icon: string
name: string
position: 0
Catalog 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 Catalog resource accepts the following input properties:
- Description string
- External
Id string - An external identifier for this catalog. Must be unique within the team.
- Icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - Name string
- Position int
- Default position of the catalog when displayed in a list.
- Description string
- External
Id string - An external identifier for this catalog. Must be unique within the team.
- Icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - Name string
- Position int
- Default position of the catalog when displayed in a list.
- description string
- external_
id string - An external identifier for this catalog. Must be unique within the team.
- icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - name string
- position number
- Default position of the catalog when displayed in a list.
- description String
- external
Id String - An external identifier for this catalog. Must be unique within the team.
- icon String
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - name String
- position Integer
- Default position of the catalog when displayed in a list.
- description string
- external
Id string - An external identifier for this catalog. Must be unique within the team.
- icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - name string
- position number
- Default position of the catalog when displayed in a list.
- description str
- external_
id str - An external identifier for this catalog. Must be unique within the team.
- icon str
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - name str
- position int
- Default position of the catalog when displayed in a list.
- description String
- external
Id String - An external identifier for this catalog. Must be unique within the team.
- icon String
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - name String
- position Number
- Default position of the catalog when displayed in a list.
Outputs
All input properties are implicitly available as output properties. Additionally, the Catalog resource produces the following output properties:
- id string
- The provider-assigned unique ID for this managed resource.
- managed_
by string - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync.
- id str
- The provider-assigned unique ID for this managed resource.
- managed_
by str - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync.
Look up Existing Catalog Resource
Get an existing Catalog 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?: CatalogState, opts?: CustomResourceOptions): Catalog@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
external_id: Optional[str] = None,
icon: Optional[str] = None,
managed_by: Optional[str] = None,
name: Optional[str] = None,
position: Optional[int] = None) -> Catalogfunc GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)public static Catalog get(String name, Output<String> id, CatalogState state, CustomResourceOptions options)resources: _: type: rootly:Catalog get: id: ${id}import {
to = rootly_catalog.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.
- Description string
- External
Id string - An external identifier for this catalog. Must be unique within the team.
- Icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - Managed
By string - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - Name string
- Position int
- Default position of the catalog when displayed in a list.
- Description string
- External
Id string - An external identifier for this catalog. Must be unique within the team.
- Icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - Managed
By string - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - Name string
- Position int
- Default position of the catalog when displayed in a list.
- description string
- external_
id string - An external identifier for this catalog. Must be unique within the team.
- icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - managed_
by string - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - name string
- position number
- Default position of the catalog when displayed in a list.
- description String
- external
Id String - An external identifier for this catalog. Must be unique within the team.
- icon String
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - managed
By String - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - name String
- position Integer
- Default position of the catalog when displayed in a list.
- description string
- external
Id string - An external identifier for this catalog. Must be unique within the team.
- icon string
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - managed
By string - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - name string
- position number
- Default position of the catalog when displayed in a list.
- description str
- external_
id str - An external identifier for this catalog. Must be unique within the team.
- icon str
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - managed_
by str - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - name str
- position int
- Default position of the catalog when displayed in a list.
- description String
- external
Id String - An external identifier for this catalog. Must be unique within the team.
- icon String
- Value must be one of
globe-alt,server-stack,users,user-group,chart-bar,shapes,light-bulb,cursor-arrow-ripple. - managed
By String - Which source manages this resource (read-only).. Value must be one of
web,adminWeb,api,terraform,pulumi,backstage,catalogSync. - name String
- position Number
- Default position of the catalog when displayed in a list.
Import
rootly.Catalog can be imported using the import command.
$ pulumi import rootly:index/catalog:Catalog 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
rootlyTerraform Provider.
Viewing docs for Rootly v3.8.0
published on Thursday, Jul 30, 2026 by rootlyhq
published on Thursday, Jul 30, 2026 by rootlyhq