[ aws . fsx ]

restore-volume-from-snapshot

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  restore-volume-from-snapshot
[--client-request-token <value>]
--volume-id <value>
--snapshot-id <value>
[--options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-request-token (string)

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

--volume-id (string)

The ID of the volume that you are restoring.

--snapshot-id (string)

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

--options (list)

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, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any volumes cloned from this volume. If there are any cloned volumes and this option isn’t used, RestoreVolumeFromSnapshot fails.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  DELETE_INTERMEDIATE_SNAPSHOTS
  DELETE_CLONED_VOLUMES

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

VolumeId -> (string)

The ID of the volume that you restored.

Lifecycle -> (string)

The lifecycle state of the volume being restored.