Skip to main content

rum_retention_quotas

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

Overview

Namerum_retention_quotas
TypeResource
Iddatadog.digital_experience.rum_retention_quotas

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe identifier of the scope the retention quota configuration applies to. (example: cd73a516-a481-4af5-8352-9b577465c77b)
attributesobjectThe RUM retention quota configuration properties.
typestringThe type of the resource, always rum_quota_config. (rum_quota_config) (default: rum_quota_config, example: rum_quota_config)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_rum_quota_configselectscope_type, scope_idGet the RUM retention quota configuration for a given scope.
upsert_rum_quota_configreplacescope_type, scope_id, dataCreate or update the RUM retention quota configuration for a given scope.<br />Returns the retention quota configuration object when the request is successful.
delete_rum_quota_configdeletescope_type, scope_idDelete the RUM retention quota configuration for a given scope.

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.

NameDatatypeDescription
scope_idstringThe identifier of the scope the retention quota configuration applies to. For the application scope, this is the RUM application ID.
scope_typestringThe type of scope the retention quota configuration applies to. application is the only supported scope type.
sitestringThe 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 the RUM retention quota configuration for a given scope.

SELECT
id,
attributes,
type
FROM datadog.digital_experience.rum_retention_quotas
WHERE scope_type = '{{ scope_type }}' -- required
AND scope_id = '{{ scope_id }}' -- required
;

REPLACE examples

Create or update the RUM retention quota configuration for a given scope.<br />Returns the retention quota configuration object when the request is successful.

REPLACE datadog.digital_experience.rum_retention_quotas
SET
data = '{{ data }}'
WHERE
scope_type = '{{ scope_type }}' --required
AND scope_id = '{{ scope_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

Delete the RUM retention quota configuration for a given scope.

DELETE FROM datadog.digital_experience.rum_retention_quotas
WHERE scope_type = '{{ scope_type }}' --required
AND scope_id = '{{ scope_id }}' --required
;