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

rootly.Catalog

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_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,
            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.

    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",
    Icon = "string",
    Name = "string",
    Position = 0,
});

    example, err := rootly.NewCatalog(ctx, "catalogResource", &rootly.CatalogArgs{
	Description: pulumi.String("string"),
	Icon:        pulumi.String("string"),
	Name:        pulumi.String("string"),
	Position:    pulumi.Int(0),
})

    var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
    .description("string")
    .icon("string")
    .name("string")
    .position(0)
    .build());

    catalog_resource = rootly.Catalog("catalogResource",
    description="string",
    icon="string",
    name="string",
    position=0)

    const catalogResource = new rootly.Catalog("catalogResource", {
    description: "string",
    icon: "string",
    name: "string",
    position: 0,
});

    type: rootly:Catalog
properties:
    description: 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
    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
    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
    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
    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
    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
    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.
    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 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,
        icon: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None) -> Catalog
    func 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}
    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
    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
    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
    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
    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
    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
    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.

    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 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.