Skip to content

Lock Snapshot

ec2_lock_snapshot R Documentation

Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration

Description

Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted.

You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:

  • If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.

  • If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.

  • If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.

Usage

ec2_lock_snapshot(SnapshotId, DryRun, LockMode, CoolOffPeriod,
  LockDuration, ExpirationDate)

Arguments

SnapshotId

[required] The ID of the snapshot to lock.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

LockMode

[required] The mode in which to lock the snapshot. Specify one of the following:

  • governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:

    • The lock duration expires.

    • The snapshot is unlocked by a user with the appropriate permissions.

    Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.

    If you lock a snapshot in governance mode, omit CoolOffPeriod.

  • compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.

    If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.

CoolOffPeriod

The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.

The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.

To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.

If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.

Allowed values: Min 1, max 72.

LockDuration

The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.

You must specify either this parameter or ExpirationDate, but not both.

Allowed values: Min: 1, max 36500

ExpirationDate

The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

You must specify either this parameter or LockDuration, but not both.

Value

A list with the following syntax: 

list(
  SnapshotId = "string",
  LockState = "compliance"|"governance"|"compliance-cooloff"|"expired",
  LockDuration = 123,
  CoolOffPeriod = 123,
  CoolOffPeriodExpiresOn = as.POSIXct(
    "2015-01-01"
  ),
  LockCreatedOn = as.POSIXct(
    "2015-01-01"
  ),
  LockExpiresOn = as.POSIXct(
    "2015-01-01"
  ),
  LockDurationStartTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$lock_snapshot(
  SnapshotId = "string",
  DryRun = TRUE|FALSE,
  LockMode = "compliance"|"governance",
  CoolOffPeriod = 123,
  LockDuration = 123,
  ExpirationDate = as.POSIXct(
    "2015-01-01"
  )
)