getCatalogType

incident 5.19.0, Nov 18 25

incident 5.19.0 published on Tuesday, Nov 18, 2025 by incident-io

Schema (JSON)

incident-io/terraform-provider-incident

incident 5.19.0 published on Tuesday, Nov 18, 2025 by incident-io

Schema (JSON)

incident-io/terraform-provider-incident

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  # Now provision the entries for the catalog type.
  services:
    type: incident:CatalogEntries
    properties:
      catalogEntriesId: ${service.id}
      entries:
        primary:
          name: artist-web
          description: public-websites
          tags:
            - java
variables:
  # Reference the catalog type by its name.
  service:
    fn::invoke:
      function: incident:getCatalogType
      arguments:
        name: Service

Using getCatalogType

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCatalogType(args: GetCatalogTypeArgs, opts?: InvokeOptions): Promise<GetCatalogTypeResult>
function getCatalogTypeOutput(args: GetCatalogTypeOutputArgs, opts?: InvokeOptions): Output<GetCatalogTypeResult>

def get_catalog_type(categories: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     type_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCatalogTypeResult
def get_catalog_type_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     type_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCatalogTypeResult]

func LookupCatalogType(ctx *Context, args *LookupCatalogTypeArgs, opts ...InvokeOption) (*LookupCatalogTypeResult, error)
func LookupCatalogTypeOutput(ctx *Context, args *LookupCatalogTypeOutputArgs, opts ...InvokeOption) LookupCatalogTypeResultOutput

> Note: This function is named LookupCatalogType in the Go SDK.

public static class GetCatalogType 
{
    public static Task<GetCatalogTypeResult> InvokeAsync(GetCatalogTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogTypeResult> Invoke(GetCatalogTypeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogTypeResult> getCatalogType(GetCatalogTypeArgs args, InvokeOptions options)
public static Output<GetCatalogTypeResult> getCatalogType(GetCatalogTypeArgs args, InvokeOptions options)

fn::invoke:
  function: incident:index/getCatalogType:getCatalogType
  arguments:
    # arguments dictionary

The following arguments are supported:

Categories List<string>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
Name string: Name is the human readable name of this type
TypeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

Categories []string: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
Name string: Name is the human readable name of this type
TypeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

categories List<String>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
name String: Name is the human readable name of this type
typeName String: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

categories string[]: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
name string: Name is the human readable name of this type
typeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

categories Sequence[str]: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
name str: Name is the human readable name of this type
type_name str: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

categories List<String>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.
name String: Name is the human readable name of this type
typeName String: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

getCatalogType Result

The following output properties are available:

Description string: Human readble description of this type
Id string: ID of this catalog type
Name string: Name is the human readable name of this type
SourceRepoUrl string: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
TypeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
UseNameAsIdentifier bool: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
Categories List<string>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

Description string: Human readble description of this type
Id string: ID of this catalog type
Name string: Name is the human readable name of this type
SourceRepoUrl string: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
TypeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
UseNameAsIdentifier bool: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
Categories []string: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

description String: Human readble description of this type
id String: ID of this catalog type
name String: Name is the human readable name of this type
sourceRepoUrl String: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
typeName String: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
useNameAsIdentifier Boolean: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
categories List<String>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

description string: Human readble description of this type
id string: ID of this catalog type
name string: Name is the human readable name of this type
sourceRepoUrl string: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
typeName string: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
useNameAsIdentifier boolean: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
categories string[]: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

description str: Human readble description of this type
id str: ID of this catalog type
name str: Name is the human readable name of this type
source_repo_url str: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
type_name str: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
use_name_as_identifier bool: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
categories Sequence[str]: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

description String: Human readble description of this type
id String: ID of this catalog type
name String: Name is the human readable name of this type
sourceRepoUrl String: The url of the external repository where this type is managed. If set, users will not be able to edit the catalog type (or its entries) via the UI, and will instead be provided a link to this URL.
typeName String: The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]
useNameAsIdentifier Boolean: If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.
categories List<String>: The categories that this type belongs to, to be shown in the web dashboard. Possible values are: customer, issue-tracker, product-feature, service, on-call, team, user.

Package Details

Repository: incident incident-io/terraform-provider-incident
License
Notes: This Pulumi package is based on the incident Terraform Provider.

incident 5.19.0 published on Tuesday, Nov 18, 2025 by incident-io

Schema (JSON)

incident-io/terraform-provider-incident

incident.getCatalogType

On this page

On this page

Example Usage

Using getCatalogType

getCatalogType Result

Package Details

On this page

On this page