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

rootly.CatalogEntity

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_entity" "enterprise_tier" {
  catalog_id  = rootly_catalog.customer_tier.id
  name        = "Enterprise"
  description = "Enterprise customer tier"
}

resource "rootly_catalog_entity" "growth_tier" {
  catalog_id  = rootly_catalog.customer_tier.id
  name        = "Growth"
  description = "Growth customer tier"
}

    Create CatalogEntity Resource

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

    Constructor syntax

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

@overload
def CatalogEntity(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  backstage_id: Optional[str] = None,
                  catalog_id: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  position: Optional[int] = None,
                  properties: Optional[Sequence[CatalogEntityPropertyArgs]] = None)
    func NewCatalogEntity(ctx *Context, name string, args *CatalogEntityArgs, opts ...ResourceOption) (*CatalogEntity, error)
    public CatalogEntity(string name, CatalogEntityArgs? args = null, CustomResourceOptions? opts = null)
    public CatalogEntity(String name, CatalogEntityArgs args)
public CatalogEntity(String name, CatalogEntityArgs args, CustomResourceOptions options)

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

    example, err := rootly.NewCatalogEntity(ctx, "catalogEntityResource", &rootly.CatalogEntityArgs{
	BackstageId: pulumi.String("string"),
	CatalogId:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Position:    pulumi.Int(0),
	Properties: rootly.CatalogEntityPropertyArray{
		&rootly.CatalogEntityPropertyArgs{
			CatalogPropertyId: pulumi.String("string"),
			Value:             pulumi.String("string"),
		},
	},
})

    var catalogEntityResource = new CatalogEntity("catalogEntityResource", CatalogEntityArgs.builder()
    .backstageId("string")
    .catalogId("string")
    .description("string")
    .name("string")
    .position(0)
    .properties(CatalogEntityPropertyArgs.builder()
        .catalogPropertyId("string")
        .value("string")
        .build())
    .build());

    catalog_entity_resource = rootly.CatalogEntity("catalogEntityResource",
    backstage_id="string",
    catalog_id="string",
    description="string",
    name="string",
    position=0,
    properties=[{
        "catalog_property_id": "string",
        "value": "string",
    }])

    const catalogEntityResource = new rootly.CatalogEntity("catalogEntityResource", {
    backstageId: "string",
    catalogId: "string",
    description: "string",
    name: "string",
    position: 0,
    properties: [{
        catalogPropertyId: "string",
        value: "string",
    }],
});

    type: rootly:CatalogEntity
properties:
    backstageId: string
    catalogId: string
    description: string
    name: string
    position: 0
    properties:
        - catalogPropertyId: string
          value: string

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

    BackstageId string
    The Backstage entity ID this catalog entity is linked to.
    CatalogId string
    The ID of the parent catalog
    Description string
    Name string
    Position int
    Default position of the item when displayed in a list.
    Properties List<CatalogEntityProperty>
    Array of property values for this catalog entity
    BackstageId string
    The Backstage entity ID this catalog entity is linked to.
    CatalogId string
    The ID of the parent catalog
    Description string
    Name string
    Position int
    Default position of the item when displayed in a list.
    Properties []CatalogEntityPropertyArgs
    Array of property values for this catalog entity
    backstageId String
    The Backstage entity ID this catalog entity is linked to.
    catalogId String
    The ID of the parent catalog
    description String
    name String
    position Integer
    Default position of the item when displayed in a list.
    properties List<CatalogEntityProperty>
    Array of property values for this catalog entity
    backstageId string
    The Backstage entity ID this catalog entity is linked to.
    catalogId string
    The ID of the parent catalog
    description string
    name string
    position number
    Default position of the item when displayed in a list.
    properties CatalogEntityProperty[]
    Array of property values for this catalog entity
    backstage_id str
    The Backstage entity ID this catalog entity is linked to.
    catalog_id str
    The ID of the parent catalog
    description str
    name str
    position int
    Default position of the item when displayed in a list.
    properties Sequence[CatalogEntityPropertyArgs]
    Array of property values for this catalog entity
    backstageId String
    The Backstage entity ID this catalog entity is linked to.
    catalogId String
    The ID of the parent catalog
    description String
    name String
    position Number
    Default position of the item when displayed in a list.
    properties List<Property Map>
    Array of property values for this catalog entity

    Outputs

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

    Get an existing CatalogEntity 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?: CatalogEntityState, opts?: CustomResourceOptions): CatalogEntity
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backstage_id: Optional[str] = None,
        catalog_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        properties: Optional[Sequence[CatalogEntityPropertyArgs]] = None) -> CatalogEntity
    func GetCatalogEntity(ctx *Context, name string, id IDInput, state *CatalogEntityState, opts ...ResourceOption) (*CatalogEntity, error)
    public static CatalogEntity Get(string name, Input<string> id, CatalogEntityState? state, CustomResourceOptions? opts = null)
    public static CatalogEntity get(String name, Output<String> id, CatalogEntityState state, CustomResourceOptions options)
    resources:  _:    type: rootly:CatalogEntity    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:
    BackstageId string
    The Backstage entity ID this catalog entity is linked to.
    CatalogId string
    The ID of the parent catalog
    Description string
    Name string
    Position int
    Default position of the item when displayed in a list.
    Properties List<CatalogEntityProperty>
    Array of property values for this catalog entity
    BackstageId string
    The Backstage entity ID this catalog entity is linked to.
    CatalogId string
    The ID of the parent catalog
    Description string
    Name string
    Position int
    Default position of the item when displayed in a list.
    Properties []CatalogEntityPropertyArgs
    Array of property values for this catalog entity
    backstageId String
    The Backstage entity ID this catalog entity is linked to.
    catalogId String
    The ID of the parent catalog
    description String
    name String
    position Integer
    Default position of the item when displayed in a list.
    properties List<CatalogEntityProperty>
    Array of property values for this catalog entity
    backstageId string
    The Backstage entity ID this catalog entity is linked to.
    catalogId string
    The ID of the parent catalog
    description string
    name string
    position number
    Default position of the item when displayed in a list.
    properties CatalogEntityProperty[]
    Array of property values for this catalog entity
    backstage_id str
    The Backstage entity ID this catalog entity is linked to.
    catalog_id str
    The ID of the parent catalog
    description str
    name str
    position int
    Default position of the item when displayed in a list.
    properties Sequence[CatalogEntityPropertyArgs]
    Array of property values for this catalog entity
    backstageId String
    The Backstage entity ID this catalog entity is linked to.
    catalogId String
    The ID of the parent catalog
    description String
    name String
    position Number
    Default position of the item when displayed in a list.
    properties List<Property Map>
    Array of property values for this catalog entity

    Supporting Types

    CatalogEntityProperty, CatalogEntityPropertyArgs

    CatalogPropertyId string
    Unique ID of the catalog property
    Value string
    The value for this property
    CatalogPropertyId string
    Unique ID of the catalog property
    Value string
    The value for this property
    catalogPropertyId String
    Unique ID of the catalog property
    value String
    The value for this property
    catalogPropertyId string
    Unique ID of the catalog property
    value string
    The value for this property
    catalog_property_id str
    Unique ID of the catalog property
    value str
    The value for this property
    catalogPropertyId String
    Unique ID of the catalog property
    value String
    The value for this property

    Import

    rootly.CatalogEntity can be imported using the import command.

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