EBS class

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into EBS volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an EBS snapshot during a disaster. Then after recovery, you can restore it back to AWS or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the AWS General Reference.

Constructors

EBS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
completeSnapshot({required int changedBlocksCount, required String snapshotId, String? checksum, ChecksumAggregationMethod? checksumAggregationMethod, ChecksumAlgorithm? checksumAlgorithm}) → Future<CompleteSnapshotResponse>
Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.
getSnapshotBlock({required int blockIndex, required String blockToken, required String snapshotId}) → Future<GetSnapshotBlockResponse>
Returns the data in a block in an Amazon Elastic Block Store snapshot.
listChangedBlocks({required String secondSnapshotId, String? firstSnapshotId, int? maxResults, String? nextToken, int? startingBlockIndex}) → Future<ListChangedBlocksResponse>
Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
listSnapshotBlocks({required String snapshotId, int? maxResults, String? nextToken, int? startingBlockIndex}) → Future<ListSnapshotBlocksResponse>
Returns information about the blocks in an Amazon Elastic Block Store snapshot.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putSnapshotBlock({required Uint8List blockData, required int blockIndex, required String checksum, required ChecksumAlgorithm checksumAlgorithm, required int dataLength, required String snapshotId, int? progress}) → Future<PutSnapshotBlockResponse>
Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.
startSnapshot({required int volumeSize, String? clientToken, String? description, bool? encrypted, String? kmsKeyArn, String? parentSnapshotId, List<Tag>? tags, int? timeout}) → Future<StartSnapshotResponse>
Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited