---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_rbin_rule{% #aws_rbin_rule %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `Description`**Description**: The retention rule description.

## `exclude_resource_tags`{% #exclude_resource_tags %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ExcludeResourceTags`**Description**: [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

- `resource_tag_key`**Type**: `STRING`**Provider name**: `ResourceTagKey`**Description**: The tag key.
- `resource_tag_value`**Type**: `STRING`**Provider name**: `ResourceTagValue`**Description**: The tag value.

## `identifier`{% #identifier %}

**Type**: `STRING`**Provider name**: `Identifier`**Description**: The unique ID of the retention rule.

## `lock_configuration`{% #lock_configuration %}

**Type**: `STRUCT`**Provider name**: `LockConfiguration`**Description**: Information about the retention rule lock configuration.

- `unlock_delay`**Type**: `STRUCT`**Provider name**: `UnlockDelay`**Description**: Information about the retention rule unlock delay.
  - `unlock_delay_unit`**Type**: `STRING`**Provider name**: `UnlockDelayUnit`**Description**: The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.
  - `unlock_delay_value`**Type**: `INT32`**Provider name**: `UnlockDelayValue`**Description**: The unlock delay period, measured in the unit specified for UnlockDelayUnit.

## `lock_end_time`{% #lock_end_time %}

**Type**: `TIMESTAMP`**Provider name**: `LockEndTime`**Description**: The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

## `lock_state`{% #lock_state %}

**Type**: `STRING`**Provider name**: `LockState`**Description**: [Region-level retention rules only] The lock state for the retention rule.

- `locked` - The retention rule is locked and can't be modified or deleted.
- `pending_unlock` - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
- `unlocked` - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
- `null` - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the `locked` and `unlocked` states only; it can never transition back to `null`.



## `resource_tags`{% #resource_tags %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ResourceTags`**Description**: [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

- `resource_tag_key`**Type**: `STRING`**Provider name**: `ResourceTagKey`**Description**: The tag key.
- `resource_tag_value`**Type**: `STRING`**Provider name**: `ResourceTagValue`**Description**: The tag value.

## `resource_type`{% #resource_type %}

**Type**: `STRING`**Provider name**: `ResourceType`**Description**: The resource type retained by the retention rule.

## `retention_period`{% #retention_period %}

**Type**: `STRUCT`**Provider name**: `RetentionPeriod`**Description**: Information about the retention period for which the retention rule is to retain resources.

- `retention_period_unit`**Type**: `STRING`**Provider name**: `RetentionPeriodUnit`**Description**: The unit of time in which the retention period is measured. Currently, only `DAYS` is supported.
- `retention_period_value`**Type**: `INT32`**Provider name**: `RetentionPeriodValue`**Description**: The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

## `rule_arn`{% #rule_arn %}

**Type**: `STRING`**Provider name**: `RuleArn`**Description**: The Amazon Resource Name (ARN) of the retention rule.

## `status`{% #status %}

**Type**: `STRING`**Provider name**: `Status`**Description**: The state of the retention rule. Only retention rules that are in the `available` state retain resources.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`