Class: Aws::FSx::Types::RestoreVolumeFromSnapshotRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass RestoreVolumeFromSnapshotRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  volume_id: "VolumeId", # required
  snapshot_id: "SnapshotId", # required
  options: ["DELETE_INTERMEDIATE_SNAPSHOTS"], # accepts DELETE_INTERMEDIATE_SNAPSHOTS, DELETE_CLONED_VOLUMES
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

(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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


6791
6792
6793
6794
6795
6796
6797
6798
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6791

class RestoreVolumeFromSnapshotRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :snapshot_id,
  :options)
  SENSITIVE = []
  include Aws::Structure
end

#optionsArray<String>

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 dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

Returns:

  • (Array<String>)


6791
6792
6793
6794
6795
6796
6797
6798
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6791

class RestoreVolumeFromSnapshotRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :snapshot_id,
  :options)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_idString

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

Returns:

  • (String)


6791
6792
6793
6794
6795
6796
6797
6798
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6791

class RestoreVolumeFromSnapshotRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :snapshot_id,
  :options)
  SENSITIVE = []
  include Aws::Structure
end

#volume_idString

The ID of the volume that you are restoring.

Returns:

  • (String)


6791
6792
6793
6794
6795
6796
6797
6798
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6791

class RestoreVolumeFromSnapshotRequest < Struct.new(
  :client_request_token,
  :volume_id,
  :snapshot_id,
  :options)
  SENSITIVE = []
  include Aws::Structure
end