1. Packages
  2. Incident Provider
  3. API Docs
  4. getCatalogEntry
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io

incident.getCatalogEntry

Explore with Pulumi AI

incident logo
incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io

    This data source provides information about a catalog entry. It can be used to look up a catalog entry by providing the catalog_type_id and an identifier.

    The API will automatically match the identifier against names, external IDs, and aliases.

    Using getCatalogEntry

    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 getCatalogEntry(args: GetCatalogEntryArgs, opts?: InvokeOptions): Promise<GetCatalogEntryResult>
    function getCatalogEntryOutput(args: GetCatalogEntryOutputArgs, opts?: InvokeOptions): Output<GetCatalogEntryResult>
    def get_catalog_entry(catalog_type_id: Optional[str] = None,
                          identifier: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCatalogEntryResult
    def get_catalog_entry_output(catalog_type_id: Optional[pulumi.Input[str]] = None,
                          identifier: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCatalogEntryResult]
    func LookupCatalogEntry(ctx *Context, args *LookupCatalogEntryArgs, opts ...InvokeOption) (*LookupCatalogEntryResult, error)
    func LookupCatalogEntryOutput(ctx *Context, args *LookupCatalogEntryOutputArgs, opts ...InvokeOption) LookupCatalogEntryResultOutput

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

    public static class GetCatalogEntry 
    {
        public static Task<GetCatalogEntryResult> InvokeAsync(GetCatalogEntryArgs args, InvokeOptions? opts = null)
        public static Output<GetCatalogEntryResult> Invoke(GetCatalogEntryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCatalogEntryResult> getCatalogEntry(GetCatalogEntryArgs args, InvokeOptions options)
    public static Output<GetCatalogEntryResult> getCatalogEntry(GetCatalogEntryArgs args, InvokeOptions options)
    
    fn::invoke:
      function: incident:index/getCatalogEntry:getCatalogEntry
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CatalogTypeId string
    ID of this catalog type
    Identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    CatalogTypeId string
    ID of this catalog type
    Identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    catalogTypeId String
    ID of this catalog type
    identifier String
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    catalogTypeId string
    ID of this catalog type
    identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    catalog_type_id str
    ID of this catalog type
    identifier str
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    catalogTypeId String
    ID of this catalog type
    identifier String
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.

    getCatalogEntry Result

    The following output properties are available:

    Aliases List<string>
    Optional aliases that can be used to reference this entry
    AttributeValues List<GetCatalogEntryAttributeValue>
    CatalogTypeId string
    ID of this catalog type
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    Id string
    The ID of the catalog entry
    Identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    Name string
    Name is the human readable name of this entry
    Rank double
    When catalog type is ranked, this is used to help order things
    Aliases []string
    Optional aliases that can be used to reference this entry
    AttributeValues []GetCatalogEntryAttributeValue
    CatalogTypeId string
    ID of this catalog type
    ExternalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    Id string
    The ID of the catalog entry
    Identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    Name string
    Name is the human readable name of this entry
    Rank float64
    When catalog type is ranked, this is used to help order things
    aliases List<String>
    Optional aliases that can be used to reference this entry
    attributeValues List<GetCatalogEntryAttributeValue>
    catalogTypeId String
    ID of this catalog type
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    id String
    The ID of the catalog entry
    identifier String
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    name String
    Name is the human readable name of this entry
    rank Double
    When catalog type is ranked, this is used to help order things
    aliases string[]
    Optional aliases that can be used to reference this entry
    attributeValues GetCatalogEntryAttributeValue[]
    catalogTypeId string
    ID of this catalog type
    externalId string
    An optional alternative ID for this entry, which is ensured to be unique for the type
    id string
    The ID of the catalog entry
    identifier string
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    name string
    Name is the human readable name of this entry
    rank number
    When catalog type is ranked, this is used to help order things
    aliases Sequence[str]
    Optional aliases that can be used to reference this entry
    attribute_values Sequence[GetCatalogEntryAttributeValue]
    catalog_type_id str
    ID of this catalog type
    external_id str
    An optional alternative ID for this entry, which is ensured to be unique for the type
    id str
    The ID of the catalog entry
    identifier str
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    name str
    Name is the human readable name of this entry
    rank float
    When catalog type is ranked, this is used to help order things
    aliases List<String>
    Optional aliases that can be used to reference this entry
    attributeValues List<Property Map>
    catalogTypeId String
    ID of this catalog type
    externalId String
    An optional alternative ID for this entry, which is ensured to be unique for the type
    id String
    The ID of the catalog entry
    identifier String
    The identifier to use for finding the catalog entry. This can be a name, external ID, or alias.
    name String
    Name is the human readable name of this entry
    rank Number
    When catalog type is ranked, this is used to help order things

    Supporting Types

    GetCatalogEntryAttributeValue

    ArrayValues List<string>
    The value of this element of the array, in a format suitable for this attribute type.
    Attribute string
    The ID of this attribute.
    Value string
    The value of this attribute, in a format suitable for this attribute type.
    ArrayValues []string
    The value of this element of the array, in a format suitable for this attribute type.
    Attribute string
    The ID of this attribute.
    Value string
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues List<String>
    The value of this element of the array, in a format suitable for this attribute type.
    attribute String
    The ID of this attribute.
    value String
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues string[]
    The value of this element of the array, in a format suitable for this attribute type.
    attribute string
    The ID of this attribute.
    value string
    The value of this attribute, in a format suitable for this attribute type.
    array_values Sequence[str]
    The value of this element of the array, in a format suitable for this attribute type.
    attribute str
    The ID of this attribute.
    value str
    The value of this attribute, in a format suitable for this attribute type.
    arrayValues List<String>
    The value of this element of the array, in a format suitable for this attribute type.
    attribute String
    The ID of this attribute.
    value String
    The value of this attribute, in a format suitable for this attribute type.

    Package Details

    Repository
    incident incident-io/terraform-provider-incident
    License
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    incident logo
    incident 5.5.0 published on Wednesday, Apr 30, 2025 by incident-io