tag_pipeline_rulesets

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

Overview

Name	tag_pipeline_rulesets
Type	Resource
Id	datadog.cloud_costs.tag_pipeline_rulesets

Fields

The following fields are returned by SELECT queries:

get_tag_pipelines_ruleset

Name	Datatype	Description
id	string	The RulesetRespData id.
attributes	object	The definition of RulesetRespDataAttributes object.
type	string	Ruleset resource type. (ruleset) (default: ruleset, example: ruleset)

list_tag_pipelines_rulesets

Name	Datatype	Description
id	string	The RulesetRespData id.
attributes	object	The definition of RulesetRespDataAttributes object.
type	string	Ruleset resource type. (ruleset) (default: ruleset, example: ruleset)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tag_pipelines_ruleset	select	ruleset_id		Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID
list_tag_pipelines_rulesets	select			List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization
create_tag_pipelines_ruleset	insert			Create a new tag pipeline ruleset with the specified rules and configuration
update_tag_pipelines_ruleset	update	ruleset_id		Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration
delete_tag_pipelines_ruleset	delete	ruleset_id		Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID
reorder_tag_pipelines_rulesets	exec	data		Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets
validate_query	exec			Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

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
ruleset_id	string	The unique identifier of the ruleset
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.

SELECT examples

get_tag_pipelines_ruleset

Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID

SELECT
id,
attributes,
type
FROM datadog.cloud_costs.tag_pipeline_rulesets
WHERE ruleset_id = '{{ ruleset_id }}' -- required
;

list_tag_pipelines_rulesets

List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization

SELECT
id,
attributes,
type
FROM datadog.cloud_costs.tag_pipeline_rulesets
;

INSERT examples

create_tag_pipelines_ruleset

Create a new tag pipeline ruleset with the specified rules and configuration

INSERT INTO datadog.cloud_costs.tag_pipeline_rulesets (
data
)
SELECT 
'{{ data }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: tag_pipeline_rulesets
props:
  - name: data
    description: |
      The definition of `CreateRulesetRequestData` object.
    value:
      attributes:
        enabled: {{ enabled }}
        rules:
          - enabled: {{ enabled }}
            mapping:
              destination_key: "{{ destination_key }}"
              if_not_exists: {{ if_not_exists }}
              if_tag_exists: "{{ if_tag_exists }}"
              source_keys:
                - "{{ source_keys }}"
            metadata: "{{ metadata }}"
            name: "{{ name }}"
            query:
              addition:
                key: "{{ key }}"
                value: "{{ value }}"
              case_insensitivity: {{ case_insensitivity }}
              if_not_exists: {{ if_not_exists }}
              if_tag_exists: "{{ if_tag_exists }}"
              query: "{{ query }}"
            reference_table:
              case_insensitivity: {{ case_insensitivity }}
              field_pairs:
                - input_column: "{{ input_column }}"
                  output_key: "{{ output_key }}"
              if_not_exists: {{ if_not_exists }}
              if_tag_exists: "{{ if_tag_exists }}"
              source_keys:
                - "{{ source_keys }}"
              table_name: "{{ table_name }}"
      id: "{{ id }}"
      type: "{{ type }}"

UPDATE examples

update_tag_pipelines_ruleset

Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration

UPDATE datadog.cloud_costs.tag_pipeline_rulesets
SET 
data = '{{ data }}'
WHERE 
ruleset_id = '{{ ruleset_id }}' --required
RETURNING
data;

DELETE examples

delete_tag_pipelines_ruleset

Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID

DELETE FROM datadog.cloud_costs.tag_pipeline_rulesets
WHERE ruleset_id = '{{ ruleset_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

reorder_tag_pipelines_rulesets

Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets

EXEC datadog.cloud_costs.tag_pipeline_rulesets.reorder_tag_pipelines_rulesets 
@@json=
'{
"data": "{{ data }}"
}'
;

validate_query

Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

EXEC datadog.cloud_costs.tag_pipeline_rulesets.validate_query 
@@json=
'{
"data": "{{ data }}"
}'
;