rum_application_retention_filter_permanents

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

Overview

Name	rum_application_retention_filter_permanents
Type	Resource
Id	datadog.digital_experience.rum_application_retention_filter_permanents

Fields

The following fields are returned by SELECT queries:

get_permanent_retention_filter

Name	Datatype	Description
id	string	The identifier of a permanent RUM retention filter. (rum_apm_flat_sampling, synthetics_sessions, forced_replay_sessions) (example: synthetics_sessions)
attributes	object	The attributes of a permanent RUM retention filter.
type	string	The type of the resource. The value should always be permanent_retention_filters. (permanent_retention_filters) (default: permanent_retention_filters, example: permanent_retention_filters)

list_permanent_retention_filters

Name	Datatype	Description
id	string	The identifier of a permanent RUM retention filter. (rum_apm_flat_sampling, synthetics_sessions, forced_replay_sessions) (example: synthetics_sessions)
attributes	object	The attributes of a permanent RUM retention filter.
type	string	The type of the resource. The value should always be permanent_retention_filters. (permanent_retention_filters) (default: permanent_retention_filters, example: permanent_retention_filters)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_permanent_retention_filter	select	app_id, permanent_rf_id		Get a permanent RUM retention filter for a RUM application by its identifier.
list_permanent_retention_filters	select	app_id		Get the list of permanent RUM retention filters for a RUM application.<br />Permanent retention filters are predefined filters that cannot be created or deleted.<br />For each filter, the editability block indicates which cross-product fields can be updated.
update_permanent_retention_filter	update	app_id, permanent_rf_id, data		Update the cross-product sampling configuration of a permanent RUM retention filter for a RUM application.<br />Only fields marked as editable in the editability block of the filter can be updated.<br />Updating a non-editable field returns a 400 response.

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
app_id	string	RUM application ID.
permanent_rf_id	string	The identifier of the permanent RUM retention filter.
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_permanent_retention_filter

Get a permanent RUM retention filter for a RUM application by its identifier.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_application_retention_filter_permanents
WHERE app_id = '{{ app_id }}' -- required
AND permanent_rf_id = '{{ permanent_rf_id }}' -- required
;

list_permanent_retention_filters

Get the list of permanent RUM retention filters for a RUM application.<br />Permanent retention filters are predefined filters that cannot be created or deleted.<br />For each filter, the editability block indicates which cross-product fields can be updated.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_application_retention_filter_permanents
WHERE app_id = '{{ app_id }}' -- required
;

UPDATE examples

update_permanent_retention_filter

Update the cross-product sampling configuration of a permanent RUM retention filter for a RUM application.<br />Only fields marked as editable in the editability block of the filter can be updated.<br />Updating a non-editable field returns a 400 response.

UPDATE datadog.digital_experience.rum_application_retention_filter_permanents
SET 
data = '{{ data }}'
WHERE 
app_id = '{{ app_id }}' --required
AND permanent_rf_id = '{{ permanent_rf_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;