You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EBS::Types::PutSnapshotBlockRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutSnapshotBlockRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  snapshot_id: "SnapshotId", # required
  block_index: 1, # required
  block_data: source_file, # file/IO object, or string data, required
  data_length: 1, # required
  progress: 1,
  checksum: "Checksum", # required
  checksum_algorithm: "SHA256", # required, accepts SHA256
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#block_data ⇒ IO

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (IO) —

    The data to write to the block.

#block_index ⇒ Integer

The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

Returns:

  • (Integer) —

    The block index of the block in which to write the data.

#checksum ⇒ String

A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

Returns:

  • (String) —

    A Base64-encoded SHA256 checksum of the data.

#checksum_algorithm ⇒ String

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

Possible values:

  • SHA256

Returns:

  • (String) —

    The algorithm used to generate the checksum.

#data_length ⇒ Integer

The size of the data to write to the block, in bytes. Currently, the only supported size is 524288.

Valid values: 524288

Returns:

  • (Integer) —

    The size of the data to write to the block, in bytes.

#progress ⇒ Integer

The progress of the write process, as a percentage.

Returns:

  • (Integer) —

    The progress of the write process, as a percentage.

#snapshot_id ⇒ String

The ID of the snapshot.

Returns:

  • (String) —

    The ID of the snapshot.