Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateRuleRequest

Hierarchy

Index

Properties

Optional Description

Description: undefined | string

The retention rule description.

Identifier

Identifier: string | undefined

The unique ID of the retention rule.

Optional ResourceTags

ResourceTags: ResourceTag[]

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Optional ResourceType

ResourceType: ResourceType | string

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Optional RetentionPeriod

RetentionPeriod: RetentionPeriod

Information about the retention period for which the retention rule is to retain resources.