Skip to main content

retention_period

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

Overview

Nameretention_period
TypeResource
Idsumologic.threat_intel.retention_period

Fields

The following fields are returned by SELECT queries:

Threat intel indicators store retention period.

NameDatatypeDescription
retention_periodinteger (int64)Retention period in days. (wire: retentionPeriod)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectregionGet the threat intel indicators store retention period in terms of days.
updateupdateregion, retention_periodSets the threat intel indicators store retention period in terms of days.

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
regionstringSumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

SELECT examples

Get the threat intel indicators store retention period in terms of days.

SELECT
retention_period
FROM sumologic.threat_intel.retention_period
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

UPDATE examples

Sets the threat intel indicators store retention period in terms of days.

UPDATE sumologic.threat_intel.retention_period
SET
retention_period = {{ retention_period }}
WHERE
region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
AND retention_period = '{{ retention_period }}' --required
RETURNING
retention_period;