observability_pipelines

Creates, updates, deletes, gets or lists an observability_pipelines resource.

Overview

Name	observability_pipelines
Type	Resource
Id	datadog.remote_config.observability_pipelines

Fields

The following fields are returned by SELECT queries:

get_pipeline

Name	Datatype	Description
id	string	Unique identifier for the pipeline. (example: 3fa85f64-5717-4562-b3fc-2c963f66afa6)
attributes	object	Defines the pipeline’s name and its components (sources, processors, and destinations).
type	string	The resource type identifier. For pipeline resources, this should always be set to pipelines. (default: pipelines, example: pipelines)

list_pipelines

Name	Datatype	Description
id	string	Unique identifier for the pipeline. (example: 3fa85f64-5717-4562-b3fc-2c963f66afa6)
attributes	object	Defines the pipeline’s name and its components (sources, processors, and destinations).
type	string	The resource type identifier. For pipeline resources, this should always be set to pipelines. (default: pipelines, example: pipelines)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline	select	pipeline_id, region		Get a specific pipeline by its ID.
list_pipelines	select	region	page[size], page[number]	Retrieve a list of pipelines.
create_pipeline	insert	region, data__data		Create a new pipeline.
update_pipeline	replace	pipeline_id, region, data__data		Update a pipeline.
delete_pipeline	delete	pipeline_id, region		Delete a pipeline.
validate_pipeline	exec	region, data		Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.

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
pipeline_id	string	The ID of the pipeline to delete.
region	string	(default: datadoghq.com)
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.

SELECT examples

get_pipeline

Get a specific pipeline by its ID.

SELECT
id,
attributes,
type
FROM datadog.remote_config.observability_pipelines
WHERE pipeline_id = '{{ pipeline_id }}' -- required
AND region = '{{ region }}' -- required
;

list_pipelines

Retrieve a list of pipelines.

SELECT
id,
attributes,
type
FROM datadog.remote_config.observability_pipelines
WHERE region = '{{ region }}' -- required
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
;

INSERT examples

create_pipeline

Create a new pipeline.

INSERT INTO datadog.remote_config.observability_pipelines (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: observability_pipelines
  props:
    - name: region
      value: string
      description: Required parameter for the observability_pipelines resource.
    - name: data
      value: object
      description: |
        Contains the the pipeline configuration.

REPLACE examples

update_pipeline

Update a pipeline.

REPLACE datadog.remote_config.observability_pipelines
SET 
data__data = '{{ data }}'
WHERE 
pipeline_id = '{{ pipeline_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_pipeline

Delete a pipeline.

DELETE FROM datadog.remote_config.observability_pipelines
WHERE pipeline_id = '{{ pipeline_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

validate_pipeline

Validates a pipeline configuration without creating or updating any resources.
Returns a list of validation errors, if any.

EXEC datadog.remote_config.observability_pipelines.validate_pipeline 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;