Skip to content

Update Rule

recyclebin_update_rule R Documentation

Updates an existing Recycle Bin retention rule

Description

Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Usage

recyclebin_update_rule(Identifier, RetentionPeriod, Description,
  ResourceType, ResourceTags)

Arguments

Identifier

[required] The unique ID of the retention rule.

RetentionPeriod

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

Description

The retention rule description.

ResourceType

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

ResourceTags

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.

Value

A list with the following syntax: 

list(
  Identifier = "string",
  RetentionPeriod = list(
    RetentionPeriodValue = 123,
    RetentionPeriodUnit = "DAYS"
  ),
  Description = "string",
  ResourceType = "EBS_SNAPSHOT"|"EC2_IMAGE",
  ResourceTags = list(
    list(
      ResourceTagKey = "string",
      ResourceTagValue = "string"
    )
  ),
  Status = "pending"|"available",
  LockState = "locked"|"pending_unlock"|"unlocked",
  LockEndTime = as.POSIXct(
    "2015-01-01"
  ),
  RuleArn = "string"
)

Request syntax

svc$update_rule(
  Identifier = "string",
  RetentionPeriod = list(
    RetentionPeriodValue = 123,
    RetentionPeriodUnit = "DAYS"
  ),
  Description = "string",
  ResourceType = "EBS_SNAPSHOT"|"EC2_IMAGE",
  ResourceTags = list(
    list(
      ResourceTagKey = "string",
      ResourceTagValue = "string"
    )
  )
)