NAME

Paws::EBS::PutSnapshotBlock - Arguments for method PutSnapshotBlock on Paws::EBS

DESCRIPTION

This class represents the parameters used for calling the method PutSnapshotBlock on the Amazon Elastic Block Store service. Use the attributes of this class as arguments to method PutSnapshotBlock.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutSnapshotBlock.

SYNOPSIS

    my $ebs = Paws->service('EBS');
    my $PutSnapshotBlockResponse = $ebs->PutSnapshotBlock(
      BlockData         => 'BlobBlockData',
      BlockIndex        => 1,
      Checksum          => 'MyChecksum',
      ChecksumAlgorithm => 'SHA256',
      DataLength        => 1,
      SnapshotId        => 'MySnapshotId',
      Progress          => 1,                 # OPTIONAL
    );
    # Results:
    my $Checksum          = $PutSnapshotBlockResponse->Checksum;
    my $ChecksumAlgorithm = $PutSnapshotBlockResponse->ChecksumAlgorithm;
    # Returns a L<Paws::EBS::PutSnapshotBlockResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ebs/PutSnapshotBlock>

ATTRIBUTES

REQUIRED BlockData => Str

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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums) in the Amazon Elastic Compute Cloud User Guide.

REQUIRED BlockIndex => Int

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.

REQUIRED Checksum => Str

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

REQUIRED ChecksumAlgorithm => Str

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

Valid values are: "SHA256"

REQUIRED DataLength => Int

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

Valid values: 524288

Progress => Int

The progress of the write process, as a percentage.

REQUIRED SnapshotId => Str

The ID of the snapshot.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>