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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ebs/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:block_data]

Instance Attribute Summary collapse

Instance Attribute Details

#block_dataIO

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums

Returns:

  • (IO)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#block_indexInteger

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)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#checksumString

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

Returns:

  • (String)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#checksum_algorithmString

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

Returns:

  • (String)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#data_lengthInteger

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

Valid values: ‘524288`

Returns:

  • (Integer)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#progressInteger

The progress of the write process, as a percentage.

Returns:

  • (Integer)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end

#snapshot_idString

The ID of the snapshot.

If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see [ Using encryption] in the *Amazon Elastic Compute Cloud User Guide*..

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html

Returns:

  • (String)


477
478
479
480
481
482
483
484
485
486
487
# File 'lib/aws-sdk-ebs/types.rb', line 477

class PutSnapshotBlockRequest < Struct.new(
  :snapshot_id,
  :block_index,
  :block_data,
  :data_length,
  :progress,
  :checksum,
  :checksum_algorithm)
  SENSITIVE = [:block_data]
  include Aws::Structure
end