ebs/aws.sdk.kotlin.services.ebs

Package-level declarations

Types

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon 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 Amazon 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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

completeSnapshot

inline suspend fun EbsClient.completeSnapshot(crossinline block: CompleteSnapshotRequest.Builder.() -> Unit): 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.

listChangedBlocks

inline suspend fun EbsClient.listChangedBlocks(crossinline block: ListChangedBlocksRequest.Builder.() -> Unit): ListChangedBlocksResponse

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

listSnapshotBlocks

inline suspend fun EbsClient.listSnapshotBlocks(crossinline block: ListSnapshotBlocksRequest.Builder.() -> Unit): ListSnapshotBlocksResponse

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

putSnapshotBlock

inline suspend fun EbsClient.putSnapshotBlock(crossinline block: PutSnapshotBlockRequest.Builder.() -> Unit): 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

inline suspend fun EbsClient.startSnapshot(crossinline block: StartSnapshotRequest.Builder.() -> Unit): StartSnapshotResponse

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

withConfig

fun EbsClient.withConfig(block: EbsClient.Config.Builder.() -> Unit): EbsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.