catalog_kinds

Creates, updates, deletes, gets or lists a catalog_kinds resource.

Overview

Name	catalog_kinds
Type	Resource
Id	datadog.catalog.catalog_kinds

Fields

The following fields are returned by SELECT queries:

list_catalog_kind

Name	Datatype	Description
id	string	A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. (example: 4b163705-23c0-4573-b2fb-f6cea2163fcb)
attributes	object	Kind attributes.
meta	object	Kind metadata.
type	string	Kind.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_catalog_kind	select		page[offset], page[limit], filter[id], filter[name]	Get a list of entity kinds from Software Catalog.
upsert_catalog_kind	insert	kind		Create or update kinds in Software Catalog.
delete_catalog_kind	delete	kind_id		Delete a single kind in Software Catalog.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
kind_id	string	Entity kind.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[id]	string	Filter entities by UUID.
filter[name]	string	Filter entities by name.
page[limit]	integer (int64)	Maximum number of kinds in the response. (example: 100)
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.

SELECT examples

list_catalog_kind

Get a list of entity kinds from Software Catalog.

SELECT
id,
attributes,
meta,
type
FROM datadog.catalog.catalog_kinds
WHERE page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
AND filter[id] = '{{ filter[id] }}'
AND filter[name] = '{{ filter[name] }}'
;

INSERT examples

upsert_catalog_kind

Create or update kinds in Software Catalog.

INSERT INTO datadog.catalog.catalog_kinds (
description,
display_name,
kind
)
SELECT 
'{{ description }}',
'{{ display_name }}',
'{{ kind }}' /* required */
RETURNING
data,
meta
;

Manifest

# Description fields are for documentation purposes
- name: catalog_kinds
props:
  - name: description
    value: "{{ description }}"
    description: |
      Short description of the kind.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      The display name of the kind. Automatically generated if not provided.
  - name: kind
    value: "{{ kind }}"
    description: |
      The name of the kind to create or update. This must be in kebab-case format.

DELETE examples

delete_catalog_kind

Delete a single kind in Software Catalog.

DELETE FROM datadog.catalog.catalog_kinds
WHERE kind_id = '{{ kind_id }}' --required
;