Skip to contents

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot

Source: R/fsx_operations.R
fsx_restore_volume_from_snapshot.Rd

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

See https://www.paws-r-sdk.com/docs/fsx_restore_volume_from_snapshot/ for full documentation.

Usage

fsx_restore_volume_from_snapshot(
  ClientRequestToken = NULL,
  VolumeId,
  SnapshotId,
  Options = NULL
)

Arguments

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

VolumeId

[required] The ID of the volume that you are restoring.

SnapshotId

[required] The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Options

The settings used when restoring the specified volume from snapshot.

  • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, restore_volume_from_snapshot fails.

  • DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, restore_volume_from_snapshot fails.