Lock Rule

recyclebin_lock_rule

R Documentation

Locks a Region-level retention rule

Description

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.

Usage

recyclebin_lock_rule(Identifier, LockConfiguration)

Arguments

Identifier	[required] The unique ID of the retention rule.
LockConfiguration	[required] Information about the retention rule lock configuration.

Value

A list with the following syntax:

list(
  Identifier = "string",
  Description = "string",
  ResourceType = "EBS_SNAPSHOT"|"EC2_IMAGE",
  RetentionPeriod = list(
    RetentionPeriodValue = 123,
    RetentionPeriodUnit = "DAYS"
  ),
  ResourceTags = list(
    list(
      ResourceTagKey = "string",
      ResourceTagValue = "string"
    )
  ),
  Status = "pending"|"available",
  LockConfiguration = list(
    UnlockDelay = list(
      UnlockDelayValue = 123,
      UnlockDelayUnit = "DAYS"
    )
  ),
  LockState = "locked"|"pending_unlock"|"unlocked",
  RuleArn = "string",
  ExcludeResourceTags = list(
    list(
      ResourceTagKey = "string",
      ResourceTagValue = "string"
    )
  )
)

Request syntax

svc$lock_rule(
  Identifier = "string",
  LockConfiguration = list(
    UnlockDelay = list(
      UnlockDelayValue = 123,
      UnlockDelayUnit = "DAYS"
    )
  )
)