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

rootly.CatalogChecklistTemplate

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_checklist_template" "production_readiness" {
  catalog_id = rootly_catalog.customer_tier.id
  name       = "Production Readiness"
}

    Create CatalogChecklistTemplate Resource

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

    Constructor syntax

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

@overload
def CatalogChecklistTemplate(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             catalog_type: Optional[str] = None,
                             description: Optional[str] = None,
                             fields: Optional[Sequence[CatalogChecklistTemplateFieldArgs]] = None,
                             name: Optional[str] = None,
                             owners: Optional[Sequence[CatalogChecklistTemplateOwnerArgs]] = None,
                             scope_id: Optional[str] = None,
                             scope_type: Optional[str] = None,
                             slug: Optional[str] = None)
    func NewCatalogChecklistTemplate(ctx *Context, name string, args *CatalogChecklistTemplateArgs, opts ...ResourceOption) (*CatalogChecklistTemplate, error)
    public CatalogChecklistTemplate(string name, CatalogChecklistTemplateArgs? args = null, CustomResourceOptions? opts = null)
    public CatalogChecklistTemplate(String name, CatalogChecklistTemplateArgs args)
public CatalogChecklistTemplate(String name, CatalogChecklistTemplateArgs args, CustomResourceOptions options)

    type: rootly:CatalogChecklistTemplate
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 CatalogChecklistTemplateArgs
    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 CatalogChecklistTemplateArgs
    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 CatalogChecklistTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogChecklistTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogChecklistTemplateArgs
    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 catalogChecklistTemplateResource = new Rootly.CatalogChecklistTemplate("catalogChecklistTemplateResource", new()
{
    CatalogType = "string",
    Description = "string",
    Fields = new[]
    {
        new Rootly.Inputs.CatalogChecklistTemplateFieldArgs
        {
            CatalogPropertyId = "string",
            FieldKey = "string",
            FieldSource = "string",
        },
    },
    Name = "string",
    Owners = new[]
    {
        new Rootly.Inputs.CatalogChecklistTemplateOwnerArgs
        {
            Id = "string",
            Type = "string",
        },
    },
    ScopeId = "string",
    ScopeType = "string",
    Slug = "string",
});

    example, err := rootly.NewCatalogChecklistTemplate(ctx, "catalogChecklistTemplateResource", &rootly.CatalogChecklistTemplateArgs{
	CatalogType: pulumi.String("string"),
	Description: pulumi.String("string"),
	Fields: rootly.CatalogChecklistTemplateFieldArray{
		&rootly.CatalogChecklistTemplateFieldArgs{
			CatalogPropertyId: pulumi.String("string"),
			FieldKey:          pulumi.String("string"),
			FieldSource:       pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Owners: rootly.CatalogChecklistTemplateOwnerArray{
		&rootly.CatalogChecklistTemplateOwnerArgs{
			Id:   pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	ScopeId:   pulumi.String("string"),
	ScopeType: pulumi.String("string"),
	Slug:      pulumi.String("string"),
})

    var catalogChecklistTemplateResource = new CatalogChecklistTemplate("catalogChecklistTemplateResource", CatalogChecklistTemplateArgs.builder()
    .catalogType("string")
    .description("string")
    .fields(CatalogChecklistTemplateFieldArgs.builder()
        .catalogPropertyId("string")
        .fieldKey("string")
        .fieldSource("string")
        .build())
    .name("string")
    .owners(CatalogChecklistTemplateOwnerArgs.builder()
        .id("string")
        .type("string")
        .build())
    .scopeId("string")
    .scopeType("string")
    .slug("string")
    .build());

    catalog_checklist_template_resource = rootly.CatalogChecklistTemplate("catalogChecklistTemplateResource",
    catalog_type="string",
    description="string",
    fields=[{
        "catalog_property_id": "string",
        "field_key": "string",
        "field_source": "string",
    }],
    name="string",
    owners=[{
        "id": "string",
        "type": "string",
    }],
    scope_id="string",
    scope_type="string",
    slug="string")

    const catalogChecklistTemplateResource = new rootly.CatalogChecklistTemplate("catalogChecklistTemplateResource", {
    catalogType: "string",
    description: "string",
    fields: [{
        catalogPropertyId: "string",
        fieldKey: "string",
        fieldSource: "string",
    }],
    name: "string",
    owners: [{
        id: "string",
        type: "string",
    }],
    scopeId: "string",
    scopeType: "string",
    slug: "string",
});

    type: rootly:CatalogChecklistTemplate
properties:
    catalogType: string
    description: string
    fields:
        - catalogPropertyId: string
          fieldKey: string
          fieldSource: string
    name: string
    owners:
        - id: string
          type: string
    scopeId: string
    scopeType: string
    slug: string

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

    CatalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    Description string
    The description of the checklist template
    Fields List<CatalogChecklistTemplateField>
    Template fields in position order
    Name string
    The name of the checklist template
    Owners List<CatalogChecklistTemplateOwner>
    Template owners
    ScopeId string
    The scope ID
    ScopeType string
    The scope type. Value must be one of Team, Catalog.
    Slug string
    The slug of the checklist template
    CatalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    Description string
    The description of the checklist template
    Fields []CatalogChecklistTemplateFieldArgs
    Template fields in position order
    Name string
    The name of the checklist template
    Owners []CatalogChecklistTemplateOwnerArgs
    Template owners
    ScopeId string
    The scope ID
    ScopeType string
    The scope type. Value must be one of Team, Catalog.
    Slug string
    The slug of the checklist template
    catalogType String
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description String
    The description of the checklist template
    fields List<CatalogChecklistTemplateField>
    Template fields in position order
    name String
    The name of the checklist template
    owners List<CatalogChecklistTemplateOwner>
    Template owners
    scopeId String
    The scope ID
    scopeType String
    The scope type. Value must be one of Team, Catalog.
    slug String
    The slug of the checklist template
    catalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description string
    The description of the checklist template
    fields CatalogChecklistTemplateField[]
    Template fields in position order
    name string
    The name of the checklist template
    owners CatalogChecklistTemplateOwner[]
    Template owners
    scopeId string
    The scope ID
    scopeType string
    The scope type. Value must be one of Team, Catalog.
    slug string
    The slug of the checklist template
    catalog_type str
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description str
    The description of the checklist template
    fields Sequence[CatalogChecklistTemplateFieldArgs]
    Template fields in position order
    name str
    The name of the checklist template
    owners Sequence[CatalogChecklistTemplateOwnerArgs]
    Template owners
    scope_id str
    The scope ID
    scope_type str
    The scope type. Value must be one of Team, Catalog.
    slug str
    The slug of the checklist template
    catalogType String
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description String
    The description of the checklist template
    fields List<Property Map>
    Template fields in position order
    name String
    The name of the checklist template
    owners List<Property Map>
    Template owners
    scopeId String
    The scope ID
    scopeType String
    The scope type. Value must be one of Team, Catalog.
    slug String
    The slug of the checklist template

    Outputs

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

    Get an existing CatalogChecklistTemplate 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?: CatalogChecklistTemplateState, opts?: CustomResourceOptions): CatalogChecklistTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_type: Optional[str] = None,
        description: Optional[str] = None,
        fields: Optional[Sequence[CatalogChecklistTemplateFieldArgs]] = None,
        name: Optional[str] = None,
        owners: Optional[Sequence[CatalogChecklistTemplateOwnerArgs]] = None,
        scope_id: Optional[str] = None,
        scope_type: Optional[str] = None,
        slug: Optional[str] = None) -> CatalogChecklistTemplate
    func GetCatalogChecklistTemplate(ctx *Context, name string, id IDInput, state *CatalogChecklistTemplateState, opts ...ResourceOption) (*CatalogChecklistTemplate, error)
    public static CatalogChecklistTemplate Get(string name, Input<string> id, CatalogChecklistTemplateState? state, CustomResourceOptions? opts = null)
    public static CatalogChecklistTemplate get(String name, Output<String> id, CatalogChecklistTemplateState state, CustomResourceOptions options)
    resources:  _:    type: rootly:CatalogChecklistTemplate    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:
    CatalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    Description string
    The description of the checklist template
    Fields List<CatalogChecklistTemplateField>
    Template fields in position order
    Name string
    The name of the checklist template
    Owners List<CatalogChecklistTemplateOwner>
    Template owners
    ScopeId string
    The scope ID
    ScopeType string
    The scope type. Value must be one of Team, Catalog.
    Slug string
    The slug of the checklist template
    CatalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    Description string
    The description of the checklist template
    Fields []CatalogChecklistTemplateFieldArgs
    Template fields in position order
    Name string
    The name of the checklist template
    Owners []CatalogChecklistTemplateOwnerArgs
    Template owners
    ScopeId string
    The scope ID
    ScopeType string
    The scope type. Value must be one of Team, Catalog.
    Slug string
    The slug of the checklist template
    catalogType String
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description String
    The description of the checklist template
    fields List<CatalogChecklistTemplateField>
    Template fields in position order
    name String
    The name of the checklist template
    owners List<CatalogChecklistTemplateOwner>
    Template owners
    scopeId String
    The scope ID
    scopeType String
    The scope type. Value must be one of Team, Catalog.
    slug String
    The slug of the checklist template
    catalogType string
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description string
    The description of the checklist template
    fields CatalogChecklistTemplateField[]
    Template fields in position order
    name string
    The name of the checklist template
    owners CatalogChecklistTemplateOwner[]
    Template owners
    scopeId string
    The scope ID
    scopeType string
    The scope type. Value must be one of Team, Catalog.
    slug string
    The slug of the checklist template
    catalog_type str
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description str
    The description of the checklist template
    fields Sequence[CatalogChecklistTemplateFieldArgs]
    Template fields in position order
    name str
    The name of the checklist template
    owners Sequence[CatalogChecklistTemplateOwnerArgs]
    Template owners
    scope_id str
    The scope ID
    scope_type str
    The scope type. Value must be one of Team, Catalog.
    slug str
    The slug of the checklist template
    catalogType String
    The catalog type. Value must be one of Service, Functionality, Environment, Group, Cause, IncidentType, Catalog.
    description String
    The description of the checklist template
    fields List<Property Map>
    Template fields in position order
    name String
    The name of the checklist template
    owners List<Property Map>
    Template owners
    scopeId String
    The scope ID
    scopeType String
    The scope type. Value must be one of Team, Catalog.
    slug String
    The slug of the checklist template

    Supporting Types

    CatalogChecklistTemplateField, CatalogChecklistTemplateFieldArgs

    CatalogPropertyId string
    ID of the catalog property for custom fields
    FieldKey string
    Key identifying the field
    FieldSource string
    Source of the field. Value must be one of builtin, custom.
    CatalogPropertyId string
    ID of the catalog property for custom fields
    FieldKey string
    Key identifying the field
    FieldSource string
    Source of the field. Value must be one of builtin, custom.
    catalogPropertyId String
    ID of the catalog property for custom fields
    fieldKey String
    Key identifying the field
    fieldSource String
    Source of the field. Value must be one of builtin, custom.
    catalogPropertyId string
    ID of the catalog property for custom fields
    fieldKey string
    Key identifying the field
    fieldSource string
    Source of the field. Value must be one of builtin, custom.
    catalog_property_id str
    ID of the catalog property for custom fields
    field_key str
    Key identifying the field
    field_source str
    Source of the field. Value must be one of builtin, custom.
    catalogPropertyId String
    ID of the catalog property for custom fields
    fieldKey String
    Key identifying the field
    fieldSource String
    Source of the field. Value must be one of builtin, custom.

    CatalogChecklistTemplateOwner, CatalogChecklistTemplateOwnerArgs

    Id string
    User ID for user owners, or field key for field owners
    Type string
    Type of owner. Value must be one of field, user.
    Id string
    User ID for user owners, or field key for field owners
    Type string
    Type of owner. Value must be one of field, user.
    id String
    User ID for user owners, or field key for field owners
    type String
    Type of owner. Value must be one of field, user.
    id string
    User ID for user owners, or field key for field owners
    type string
    Type of owner. Value must be one of field, user.
    id str
    User ID for user owners, or field key for field owners
    type str
    Type of owner. Value must be one of field, user.
    id String
    User ID for user owners, or field key for field owners
    type String
    Type of owner. Value must be one of field, user.

    Import

    rootly.CatalogChecklistTemplate can be imported using the import command.

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